-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Update documentation with a roadmap
- Loading branch information
1 parent
081b07b
commit 00049e3
Showing
1 changed file
with
22 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,28 @@ | ||
# dev-db | ||
# 📦 create-docker-db | ||
|
||
## Description | ||
## 📝 Description | ||
|
||
A CLI to easily create DBs for local development using Docker Compose. | ||
A CLI to easily create DBs for local development using Docker Compose. Currently supports MySQL and Postgres. | ||
|
||
## Usage | ||
## 🚀 Usage | ||
|
||
```bash | ||
npx dev-db | ||
npx create-docker-db # or bunx create docker-db | ||
``` | ||
|
||
## 🎯 Roadmap | ||
|
||
### Features | ||
|
||
- [x] Setup Changesets | ||
- [ ] Display copy-pastable connection URLs for the created databases | ||
- [ ] Modify existing Docker Compose files instead of overwriting them | ||
- [ ] Add support for more databases (see below) | ||
- [ ] Add support for more configurations (like custom container names based on project name) | ||
|
||
### Support Additional Databases | ||
|
||
- [ ] Add support for MongoDB | ||
- [ ] Add support for Redis | ||
- [ ] Add support for SQLite (easy but still) | ||
- [ ] Add support for HTTP based DB services (like PlanetScale, Turso, etc.) |