Skip to content

Latest commit

 

History

History
146 lines (105 loc) · 4.26 KB

README.md

File metadata and controls

146 lines (105 loc) · 4.26 KB

Eventials

Eventials Whitelabel

We using React JS ⚛️

Fast is better

Eventials Whiteabel is a open souce project, so you can edit with yours customizations (Users Eventials).

🚀 Get Up and Running in 10 Minutes

You can running a new Eventials Whitelabel in your local dev environment in 5 minutes with these four steps:

  1. Make a clone of project

  2. Install dependencies

  yarn
  1. Get your credentials in https://www.eventials.com/oauth-clients/

a) Create a credentials step1

b) Add a project name Add a project name

c) Copy your credentials Copy your credentials

  1. We recommend that you read a documentation of our API, you can see in this link ==> https://eventialsapi.docs.apiary.io/#

  2. Now you can create a file .env in root project and added this informations:

  REACT_APP_API_URL=
  REACT_APP_CLIENT_ID=
  REACT_APP_CLIENT_SECRET=
  1. To running the project
  yarn dev

Done, your project is running.

🌎 Translations

In project we have two files:
- **/src/i18n/messages.tsx**
- **/src/i18n/util.ts**

In messages.tsx we have dictionary of all words to translations, to en, pt and es, so you can added your words in respectives languages to after you use in all project.

In util.ts we get the current and default language of navigator and apply in translations lib.

For you use a dictionary of word you need use bellow code:

	import { FormattedMessage } from 'react-intl';

...
		//id => is a name of dictionary of words in messages.tsx
           <p>
                <FormattedMessage id="development" />
          </p>

Ready now your word will be automatically translated ;).

🎨 Customizations

In project we have a file: /src/configs/customizations.ts

export const configs = {
  // organization data
  name: 'ORGANIZATION_NAME',
  adress: 'ORGANIZATION_ADDRESS',
  phone: 'Tel.: (000) 0000-0000',
  site: 'https://www.example.com',

  // images
  logo: 'URL_LOGO_ORGANIZATION',
  descriptionImage: 'IMAGE_TO_DESCRIPTION',
  banner: ['URL_BANNER_1', 'URL_BANNER_2', 'URL_BANNER_3', '...'],
  bannerContact: 'URL_BANNER_CONTACT',

  imageTitleContact: 'URL_IMAGE_TITLE_CONTACT',

  defaultImage: 'URL_DEFAULT_IMAGE_TO_WEBINARS',

  // social media
  youtube: 'https://www.youtube.com/channel/YOUR-CHANNEL',
  linkedIn: 'https://www.linkedin.com/company/YOUR-COMPANY/',
  facebook: 'https://www.facebook.com/YOUR-PROFILE/',
  instagram: 'https://www.instagram.com/YOUR-PROFILE/',
  allWebinars: 'https://www.eventials.com/YOUR-PROFILE/talks/',

  // feature flags
  contact: false,
  typeformContact: false,

  // colors customization
  primary: '#152e4d',
  second: '#ff4d1f',
  backgroundColor: '#f5f5f5',
  backgroundColorWhite: '#fff',
  textContact: '#43464a',
  textFooter: '#fff',
  titleGrupoWebinar: 'rgba(0, 0, 0, 0.8)',
  titleCard: '#343434',
  dateCard: '#535252',
};

🤝 How to Contribute

Anyone can contribuite in this project, you need:

  1. Make a fork of project
  2. Do your changes
  3. Open a pull request and waiting

📝 License

Licensed under the MIT License.

❤️Thanks

Thanks to our many contributors ! 😃