app.brmodeloweb.com

Web application for database modeling and teaching

Released under the Apache License 2.0

Dependencies

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)

Running application

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/

Running with docker-compose

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

Tests

Unit Tests

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

E2E Tests

First, make sure you have the project up and running with database, backend, and frontend.

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

   Note: Tests will delete all models from your user. To avoid lost your work we recommend you to create a different user to run the tests

3. To run the tests you have two options:
   1. Run headless mode in your terminal window: yarn test:cy
   2. Run interactive mode: yarn cy:open

Production environments

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

Contributors ✨

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 ⚠️

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