vndangkhoa/kv-music
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add Docker part (with link to future howto) in the README

Browse source
This commit is contained in:
BlackSigkill 2026-02-06 16:59:36 +01:00
parent b349fbb329
commit 8e8225c26e
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -107,12 +107,25 @@ For alternative instances, check [INSTANCES.md](INSTANCES.md).
NOTE: Accounts wont work on self-hosted instances. NOTE: Accounts wont work on self-hosted instances.
### Prerequisites ### Option 1: Docker (Recommended)
```bash
git clone https://github.com/monochrome-music/monochrome.git
cd monochrome
docker compose up -d
```
Visit `http://localhost:3000`
For PocketBase, development mode, and advanced setups, see [DOCKER.md](DOCKER.md).
### Option 2: Manual Installation
#### Prerequisites
- [Node.js](https://nodejs.org/) (Version 20+ or 22+ recommended) - [Node.js](https://nodejs.org/) (Version 20+ or 22+ recommended)
- [Bun](https://bun.sh/) or [npm](https://www.npmjs.com/) - [Bun](https://bun.sh/) or [npm](https://www.npmjs.com/)
### Local Development #### Local Development
1. **Clone the repository:** 1. **Clone the repository:**
@ -140,7 +153,7 @@ NOTE: Accounts wont work on self-hosted instances.
4. **Open your browser:** 4. **Open your browser:**
Navigate to `http://localhost:5173/` Navigate to `http://localhost:5173/`
### Building for Production #### Building for Production
```bash ```bash
bun run build bun run build