Skip to content

BRMW is a free open source entity-relationship database modeling tool. We're working to make learning database modeling simple and accessible for everyone.

License

Notifications You must be signed in to change notification settings

brmodeloweb/brmodelo-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

All Contributors

Web application for database modeling and teaching

Hero shot

Released under the Apache License 2.0

Dependencies

To run this application you'll need:

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

Setup tests

  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)

Warning

The data from the accound you set in cypress.env.json will be wiped out after the tests run. So, don't use your real account here!

E2E tests

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

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

Production environments

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Milton Bittencourt de Souza Neto
Milton Bittencourt de Souza Neto

💻 ⚠️ 🐛 🚧
Idmar Ramos Junior (Id)
Idmar Ramos Junior (Id)

💻 🎨 📆 🚧
Felipe de Souza da Costa
Felipe de Souza da Costa

💻 🚇 👀
Márcio Santos
Márcio Santos

💻 👀
Telmo
Telmo "Trooper"

💻
Arthur Mota
Arthur Mota

💻 👀
joaomfiumari
joaomfiumari

💻 🚇
Walmyr
Walmyr

⚠️
Tárliton Basso de Godoy
Tárliton Basso de Godoy

💻 🚇
John Fercher
John Fercher

💵
Henrique Ferraz
Henrique Ferraz

💵
Paulo Ricardo Stradioti
Paulo Ricardo Stradioti

💵
Salim Nabbout
Salim Nabbout

💵

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