Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glific/glific-frontend
Frontend for the Glific platform
https://github.com/glific/glific-frontend
apollo-graphql cypress frontend graphql jest react react-router react-testing-library typescript
Last synced: 5 days ago
JSON representation
Frontend for the Glific platform
- Host: GitHub
- URL: https://github.com/glific/glific-frontend
- Owner: glific
- License: agpl-3.0
- Created: 2020-06-07T14:12:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T15:30:59.000Z (10 months ago)
- Last Synced: 2024-04-14T12:10:14.032Z (10 months ago)
- Topics: apollo-graphql, cypress, frontend, graphql, jest, react, react-router, react-testing-library, typescript
- Language: TypeScript
- Homepage: https://glific.org
- Size: 17.9 MB
- Stars: 30
- Watchers: 7
- Forks: 35
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Glific - Two Way Open Source Communication Platform
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://codecov.io/gh/glific/glific-frontend/branch/master)
[](https://discord.gg/MVf2KF)
[](https://dashboard.cypress.io/projects/ocex65/runs)
Frontend interface built using React.
## Prerequisite
- Setup the backend application. You can find the instructions [here](https://github.com/glific/glific).
- SSL is mandatory for both frontend and backend in development. You can find the instructions to generate ssl certificate [here](https://github.com/glific/glific#use-ssl-for-frontend-and-backend)
- 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
```bash
docker build \
--build-arg VITE_GLIFIC_API_PORT=API-PORT \
--no-cache -t .
```
## Localization
Update translation base file (i.e. English)
```bash
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](https://github.com/marketplace/actions/build-and-push-docker-images) images to docker hub.
## Learn More
### Glific
- [Glific.org](https://glific.org/)
- [One Pager](https://docs.google.com/document/d/1XYxNvIYzNyX2Ve99-HrmTC8utyBFaf_Y7NP1dFYxI9Q/edit?usp=sharing)
- [Google Drive](https://drive.google.com/drive/folders/1aMQvS8xWRnIEtsIkRgLodhDAM-0hg0v1?usp=sharing)
- [Product Features](https://docs.google.com/document/d/1uUWmvFkPXJ1xVMr2xaBYJztoItnqxBnfqABz5ad6Zl8/edit?usp=sharing)
- [Blogs](https://chintugudiya.org/tag/glific/)
- [Discord](https://discord.gg/scsrGUw)