https://github.com/jellydn/db-management-demo
This is simple demo of how to manage database using prisma and tbls for documentation.
https://github.com/jellydn/db-management-demo
bunjs db prisma tbls
Last synced: 4 months ago
JSON representation
This is simple demo of how to manage database using prisma and tbls for documentation.
- Host: GitHub
- URL: https://github.com/jellydn/db-management-demo
- Owner: jellydn
- Created: 2024-03-10T06:51:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T20:30:20.000Z (6 months ago)
- Last Synced: 2025-04-05T21:25:36.657Z (6 months ago)
- Topics: bunjs, db, prisma, tbls
- Language: TypeScript
- Homepage:
- Size: 406 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to db-management-demo 👋
This is simple demo of how to manage database using prisma and tbls for documentation.
[](https://www.youtube.com/watch?v=qMJAiOx9ET0)
## Prerequisites
- [Bun — A fast all-in-one JavaScript runtime](https://bun.sh/)
- [OrbStack · Fast, light, simple Docker & Linux on macOS](https://orbstack.dev/)
## Install
```sh
bun install
```
## Usage
1. Start the database using docker-compose:
```sh
docker-compose up -d
```
2. Create a `.env` file based on the `.env.example` file.
3. Generate the Prisma client:
```sh
make migrate-dev
```
4. Generate the documentation:
```sh
make db-doc
```
Alternatively, seed the database with:
```sh
make seed
```
More commands can be found in the [`Makefile`](./Makefile).
# Resources
- [Quickstart with TypeScript & SQLite | Prisma Docs](https://www.prisma.io/docs/getting-started/quickstart)
- [k1LoW/tbls: tbls is a CI-Friendly tool for document a database, written in Go.](https://github.com/k1LoW/tbls#quick-start)
- [bruin-data/ingestr: ingestr is a CLI tool to copy data between any databases with a single command seamlessly.](https://github.com/bruin-data/ingestr)
- [Creating PostgreSQL service containers](https://docs.github.com/en/actions/using-containerized-services/creating-postgresql-service-containers)
- [Automatically commit and push changed files back to GitHub with GitHub Action](https://github.com/stefanzweifel/git-auto-commit-action)
## Author
👤 **Huynh Duc Dung**
- Website: https://productsway.com/
- Twitter: [@jellydn](https://twitter.com/jellydn)
- Github: [@jellydn](https://github.com/jellydn)
## Show your support
Give a ⭐️ if this project helped you!
[](https://ko-fi.com/dunghd)
[](https://paypal.me/dunghd)
[](https://www.buymeacoffee.com/dunghd)