Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.17 KB

README.md

File metadata and controls

44 lines (28 loc) · 1.17 KB
Raw

Barmaga.io UI

Barmaga.io, an open source education/learning platform. This is the client side of the project (Front-End). If you are looking for the back-end api please go tot this project edu-backend

This project is build with Gatsby

License

Getting started

  • Clone the repo
  • install the dependencies
yarn install
  • Create .env.development file in the ROOT of the project
touch .env.development
  • Add backend API URL
GATSBY_STRAPI_API_URL=API_BACK_END_HERE

If you only want to work with the front-end, and do not want to setup the back-end locally, then you can use our staging website by settings value to https://edu-api-dev.herokuapp.com

Note that staging website is running on free heroku instance and might take some times to bring the instance up, also some features might not be enabled on the staging site

  • Start the development server
yarn develop

Tests

  • To run the unit tests, run yarn test
  • To run the end to end tests, run yarn run cypress open