https://github.com/brmodeloweb/brmodelo-docs

https://github.com/brmodeloweb/brmodelo-docs

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/brmodeloweb/brmodelo-docs
• Owner: brmodeloweb
• Created: 2021-10-16T15:28:20.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T14:09:53.000Z (about 2 years ago)
• Last Synced: 2025-03-10T17:58:30.088Z (about 1 year ago)
• Size: 7.95 MB
• Stars: 14
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

          
# BR Modelo Web documentation

[docs.brmodeloweb.com](https://docs.brmodeloweb.com)

![BR Modelo Docs website](docs/assets/br-modelo-docs-preview.png)

This repository holds the oficial usage documentation of [BR Modelo Web](https://www.brmodeloweb.com) a open source web based tool to create database modeling.  

## Contribution

You're more than welcome to contribute to this docs by fixing erros, adding content or translations. Please take a look in the [contribution guidelines](#) (Contribution guidelines still pending) before submit your pull request.

## Dependencies

- [EditorConfig](https://editorconfig.org/)

- [Node.js](https://nodejs.org/) (Strongly recommended to install it via [nvm](https://github.com/nvm-sh/nvm#readme) or [n](https://github.com/tj/n#readme))

- [Yarn](https://yarnpkg.com/)

## Running application

1. Install dependencies: `yarn install`

1. Start the app: `yarn start`