Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 3.42 KB

README.md

File metadata and controls

90 lines (57 loc) · 3.42 KB
Raw

Glific - Two Way Open Source Communication Platform

License: AGPL v3 Code coverage badge GitHub issues Discord Glific

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
  • Configure below host in your /etc/hosts 127.0.0.1 glific.test

Installation steps

  1. Create a new file .env in the project root directory and copy the contents from .env.example.
  2. Do not update the '.env' file unless you are absolutely sure of what you are doing. Keep the variables same.
  3. Run yarn setup

Available Scripts

In the project directory, you can run:

yarn setup

Install the dependencies and required packages.

yarn dev

Runs the app in the development mode.

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 VITE_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

  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