Released under the Apache License 2.0

To run this application you'll need:

• EditorConfig
• Node.js (Strongly recommended to install it via nvm or n)
• Yarn
• MongoDB Community Edition (Check installation guides)

1. Install dependencies: yarn install
2. Duplicate .env.example and rename it to .env
3. Make sure you have MongoDB running (To know more: MacOS, Windows, CentOS, Ubuntu or Debian)
4. Start frontend: yarn start:frontend
5. Start server: yarn start:dev
6. Access it: http://localhost:9000/

Note: Docker setup is still a work in progress and does not offer a good developer experience. For now we recommend you to run the project locally following the instructions listed above. If you still want to use docker, here's how:

1. Make sure you have Docker Desktop running
2. Start docker: docker-compose up or docker-compose up -d
3. Access it: http://localhost:9000/
4. Once your done, finish docker: docker-compose down

1. Duplicate cypress.env.example.json and rename it to cypress.env.json
2. Update cypress.env.json with valid user credentials (Username and password)

To run E2E tests you have two options:

1. Run headless mode in your terminal window: yarn test:cy
2. Run interactive mode: yarn cy:open

To run the unit tests you have two options:

• yarn test to run all the tests and collect the coverage report. Or;
• Execute in a watch mode by running yarn test:watch

• Stable: https://app.brmodeloweb.com
• Staging: https://brmodelo-stage.herokuapp.com

Thanks goes to these wonderful people (emoji key):

Milton Bittencourt de Souza Neto 💻 ⚠️ 🐛 🚧	Idmar Ramos Junior (Id) 💻 🎨 📆 🚧	Felipe de Souza da Costa 💻 🚇 👀	Márcio Santos 💻 👀	Telmo "Trooper" 💻	Arthur Mota 💻 👀	joaomfiumari 💻 🚇
Walmyr ⚠️	Tárliton Basso de Godoy 💻 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!