diff --git a/README.md b/README.md index 6468b263..70532c1f 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,17 @@ cp config.env.example config.env docker compose up -d ``` +## Developer + +We try to make it as easy for you to run Mixwave locally. Install [Bun](https://bun.sh/) (v1.1.30 or above), and [pnpm](https://pnpm.io/installation). Next up, make sure you have the `config.env` file configured properly as well. Run the following commands at the root of the project: + +```shell +pnpm install +pnpm dev # This'll spin up everything for you, with hot reloading and all. +``` + +Go to `http://localhost:5200` and you're good to go! + There's more info in the [Getting Started](https://matvp91.github.io/mixwave/getting-started.html) section in the docs. ## Player