https://github.com/bhanu-code/dbdrawer-sqlz
schema visualization tool for sequelize orm
https://github.com/bhanu-code/dbdrawer-sqlz
ejs expressjs javascript npm-package process-manager sequelize visualization
Last synced: 7 months ago
JSON representation
schema visualization tool for sequelize orm
- Host: GitHub
- URL: https://github.com/bhanu-code/dbdrawer-sqlz
- Owner: Bhanu-code
- License: mit
- Created: 2024-04-08T06:35:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T05:07:07.000Z (almost 2 years ago)
- Last Synced: 2025-06-10T09:07:54.173Z (8 months ago)
- Topics: ejs, expressjs, javascript, npm-package, process-manager, sequelize, visualization
- Language: EJS
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dbdrawer-sqlz
a cli tool for visualising your sequelize schema. dbdrawer-sqlz checks the data model schemas of your project ("./models") folder and visualises by running on localhost in node environment. it attaches to your project as an npm package.
## Installation
Install dbdrawer-sqlz with npm
```javascript
//install using npm
npm install -g dbdrawer-sqlz
//open terminal and type
dbdraw-s
// hit enter and it will run localhost where you can see your schema, relationship and constraints in a tablular format
```
## Screenshots
## Local Setup
```javascript
//To setup the project locally, for the repository and copy the forked copy the https url
//in the terminal write
git clone [repo-url]
cd dbdrawer-sqlz
npm install
// have a project that has "models" folder
//install dbdrawer-mongo to the project globally
npm install -g
//have a dummy project with models
//create a branch, makes changes and raise PR
//open terminal and type
dbdraw-s
// hit enter and it will run localhost where you can see your schema, relationship and constraints in a tablular format
```
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.
## License
[MIT License](LICENSE)