https://github.com/oscartbeaumont/cityscale
MySQL for hobby projects
https://github.com/oscartbeaumont/cityscale
branching mysql schema-migrations
Last synced: 7 months ago
JSON representation
MySQL for hobby projects
- Host: GitHub
- URL: https://github.com/oscartbeaumont/cityscale
- Owner: oscartbeaumont
- License: agpl-3.0
- Created: 2024-03-19T07:27:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T13:42:37.000Z (over 1 year ago)
- Last Synced: 2025-02-13T01:26:39.895Z (11 months ago)
- Topics: branching, mysql, schema-migrations
- Language: Rust
- Homepage:
- Size: 506 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cityscale
> [!WARNING]
> This project is in early development. It may not have all documented features and it's web UI is still very ugly.
The MySQL database platform for side projects.
### Features
- Create database and users from web UI
- Create and merge database branches (similar to Planetscale)
- Create and manage database backups to S3-compatible storage
- Edge runtime support via full compatibility with [`@planetscale/database-js`](https://github.com/planetscale/database-js)
- Cheap to and easy to operate (one click deploy for less than 5$ a month on [Railway](https://railway.app))
### Dashboard
Cityscale comes with a web dashboard to manage your databases.
### Deployment Guide
### Railway
> [!WARNING]
> Coming soon...
### Docker
You can deploy to any server with Docker installed using the following command:
```bash
docker volume create cityscale-data
docker run -d -p 2489:2489 -p 3306:3306 -v cityscale-data:/data ghcr.io/oscartbeaumont/cityscale:latest
```
Now to go to `http://localhost:2489` and you should be able to login with the default credentials (username and password both `admin`).
#### Development
To develop Cityscale you must have [Rust](https://www.rust-lang.org), [Docker](https://www.docker.com), [pnpm](https://pnpm.io) and [Node.js](https://nodejs.org) installed.
```bash
pnpm -C web install
./dev.sh run
```