Update readme
This commit is contained in:
lucast committed
1 parent
e89463591c
commit
3393c133fd
1 file changed
+14
-49
@@ -1,64 +1,29 @@
|
|||||||
# Music v2
|
# Music v2
|
||||||
|
|
||||||
Music v2 is a Nuxt 4 application. Its Nitro server provides the API, authentication, database access, upload handling, and media routes alongside the frontend.
|
Yet another music platform.
|
||||||
|
|
||||||
|
This is a rewrite of my [first version](https://github.com/Sniperhund/Music), everything is contained in this repo instead of v1 (v1 had a separate frontend + backend)<br />
|
||||||
|
I got tired and irritated by trying to add new features to v1, so here we are nearly 5 months in development.
|
||||||
|
|
||||||
|
It's a Nuxt 4 full stack application, hook up a S3 bucket and MongoDB service and you're basically good to go (check .env.example)
|
||||||
|
|
||||||
|
This project is mostly a inspiration of Apple Music (my go-to platform) with my personal design choices and the "I can do it" mindset.
|
||||||
|
|
||||||
|
### Debug view
|
||||||
|
|
||||||
|
There's a debug view (now only for lyric alignemt), just set `DEBUG_VIEW` to `1`. It will likely be expanded.
|
||||||
|
|
||||||
## Local setup
|
## Local setup
|
||||||
|
|
||||||
Install dependencies and create a local environment file:
|
Install dependencies and create a local environment file:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install
|
bun install
|
||||||
cp -n .env.example .env
|
cp -n .env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
For an existing local `.env`, update its values instead of replacing the file. Set `NUXT_MONGODB_URI` to a MongoDB connection string and configure the S3-compatible bucket settings below. `NUXT_TOKEN_EXPIRE` is optional and defaults to `1h`.
|
|
||||||
|
|
||||||
Run the app at <http://localhost:3000>:
|
Run the app at <http://localhost:3000>:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm run dev
|
bun run dev
|
||||||
```
|
|
||||||
|
|
||||||
## Runtime configuration
|
|
||||||
|
|
||||||
The private settings are declared in `nuxt.config.ts` and can be set with matching `NUXT_` environment variables:
|
|
||||||
|
|
||||||
| Variable | Required | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `NUXT_MONGODB_URI` | Yes | MongoDB connection URI. |
|
|
||||||
| `NUXT_PUBLIC_MEDIA_BASE_URL` | Yes for browser media URLs | Public base URL used by `GET_FILE` and `GET_AUDIO_FILE` to build direct bucket URLs. |
|
|
||||||
| `NUXT_S3_ENDPOINT` | Yes for uploads | S3-compatible endpoint URL, without the bucket path. |
|
|
||||||
| `NUXT_S3_BUCKET` | Yes for uploads | Bucket name, such as `music`. |
|
|
||||||
| `NUXT_S3_REGION` | No | S3 signing region; defaults to `us-east-1`. |
|
|
||||||
| `NUXT_S3_ACCESS_KEY_ID` | Yes for uploads | Private access key ID with object read/write/delete permissions. |
|
|
||||||
| `NUXT_S3_SECRET_ACCESS_KEY` | Yes for uploads | Private secret access key. |
|
|
||||||
| `NUXT_TOKEN_EXPIRE` | No | Session lifetime accepted by `parse-duration`, such as `1h` or `7d`; defaults to `1h`. |
|
|
||||||
|
|
||||||
For a short migration window, the server also accepts the standalone backend names `MONGODB_URI`, `TOKEN_EXPIRE`, `S3_ENDPOINT`, `S3_BUCKET`, `S3_REGION`, `S3_ACCESS_KEY_ID`, and `S3_SECRET_ACCESS_KEY` as fallbacks. Prefer the `NUXT_` names for all new deployments. `VITE_PUBLIC_BACKEND` is no longer used: browser API requests are same-origin.
|
|
||||||
|
|
||||||
Nuxt loads `.env` while running its CLI for development and local production preview, but a built server does not load `.env`. Configure these variables in the production process manager or hosting environment. See the [Nuxt runtime config guide](https://nuxt.com/docs/4.x/guide/going-further/runtime-config) and [deployment guide](https://nuxt.com/docs/4.x/getting-started/deployment).
|
|
||||||
|
|
||||||
## Production deployment
|
|
||||||
|
|
||||||
Deploy the Nuxt server using the Node.js Nitro output:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm run build
|
|
||||||
NODE_ENV=production node .output/server/index.mjs
|
|
||||||
```
|
|
||||||
|
|
||||||
The server listens on port `3000` by default; Nitro also honors `PORT`/`NITRO_PORT` and `HOST`/`NITRO_HOST`. A reverse proxy may terminate TLS and forward requests to this server. When using cookie authentication, configure a trusted proxy to preserve the public `Host` and overwrite `X-Forwarded-Proto`; the server uses these values to validate same-origin mutation requests.
|
|
||||||
|
|
||||||
The health check endpoint is `GET /api/health` and returns `{ "status": "ok" }`.
|
|
||||||
|
|
||||||
Upload credentials must allow object listing and deletion for force cleanup, as well as object writes. The public read URL must resolve the same bucket and key prefix. Audio uploads are processed in the system temporary directory, so provide writable temporary storage and install `ffmpeg` and `ffprobe` on the host. Configure an ingress or reverse-proxy request size limit appropriate for audio uploads.
|
|
||||||
|
|
||||||
`npm run generate` creates static output and cannot provide this backend, database, authentication, or upload functionality. Use the Node server deployment above.
|
|
||||||
|
|
||||||
## Checks
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npx tsc --noEmit -p .nuxt/tsconfig.app.json
|
|
||||||
npx tsc --noEmit -p .nuxt/tsconfig.server.json
|
|
||||||
npm run build
|
|
||||||
```
|
```
|
||||||
Reference in new issue
Block a user