/glific-frontend

Frontend for the Glific platform

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Glific - Two Way Open Source Communication Platform

License: AGPL v3 Code coverage badge GitHub issues Discord codebeat badge

Frontend interface built using React.

Installation steps

Note: First you will need to setup the backend application from this repo: https://github.com/glific/glific

  1. Create a new file .env in the project root directory and copy the contents from .env.example.
  2. Update the .env file with relevant configurations.
  3. 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.

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 .

Deploying release on ECS with CD

  1. If you are using AWS codebuild for CD, use buildspec.yml.sample file content for creating and pushing docker image.
  2. For using and alternative repository like docker hub, click the link to see how we can build and push docker images to docker hub.

Learn More

Glific