Giter VIP home page Giter VIP logo

glific-frontend's Introduction

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

Installation steps

  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.

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

  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

glific-frontend's People

Contributors

akhileshnegi avatar cindyxzhang avatar claalmve avatar dependabot[bot] avatar digneshgujarathi avatar dlobo avatar dorjayyolmo avatar kumudinik avatar kurund avatar mdshamoon avatar pankaj-ag avatar rathorevaibhav avatar satendra-sr avatar shreesh1993 avatar snyk-bot avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.