Glific - Two Way Open Source Communication Platform
Frontend interface built using React.
Prerequisite
- Setup the backend application. You can find the instructions here.
- SSL is mandatory for both frontend and backend in development. You can find the instructions to generate ssl certificate here
Installation steps
- Create a new file
.envin the project root directory and copy the contents from.env.example. - Update the
.envfile with relevant configurations. - Run
yarn setup
Available Scripts
In the project directory, you can run:
yarn setup
Install the dependencies and required packages.
yarn start
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Run HOST=glific.test yarn start if you are using host configuration.
yarn test
Launches the test runner in the interactive watch mode.
yarn test:coverage
Launches the test runner in the interactive watch mode and code coverage stats.
yarn build
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
Docker image for production
docker build \
--build-arg REACT_APP_GLIFIC_API_PORT=API-PORT \
--no-cache -t .
Localization
Update translation base file (i.e. English)
yarn extract-translations
Once changed are pushed and merged into master it will be available in lokalise.com for translation.
After new strings are transalated. Use Download >> Build only. It will automatically create PR in this repo.
Note: Good to Preview before using Build only
Deploying release on ECS with CD
- If you are using AWS codebuild for CD, use buildspec.yml.sample file content for creating and pushing docker image.
- For using and alternative repository like docker hub, click the link to see how we can build and push docker images to docker hub.