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

Install dependencies: yarn install
Duplicate .env.example and rename it to .env
Make sure you have MongoDB running (To know more: MacOS, Windows, CentOS, Ubuntu or Debian)
Start frontend: yarn start:frontend
Start server: yarn start:dev
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:

Make sure you have Docker Desktop running
Start docker: docker-compose up or docker-compose up -d
Access it: http://localhost:9000/
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.

Duplicate cypress.env.example.json and rename it to cypress.env.json
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
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 ⚠️