[READ-ONLY] Mirror of https://github.com/FoxxMD/multi-scrobbler. Scrobble plays from multiple sources to multiple clients
docs.multi-scrobbler.app
deezer
docker
jellyfin
koito
lastfm
listenbrainz
maloja
mopidy
mpris
music
music-assistant
plex
scrobble
self-hosted
spotify
subsonic
tautulli
youtube-music
Update devcontainer usage with docusarus and docs
+21
-6
+10
-2
.devcontainer/devcontainer.json
+10
-2
.devcontainer/devcontainer.json
···
9
9
// "features": {},
10
10
11
11
// Use 'forwardPorts' to make a list of ports inside the container available locally.
12
-
"forwardPorts": [9078],
12
+
"forwardPorts": [9078,3000],
13
13
14
14
// Use 'postCreateCommand' to run commands after the container is created.
15
-
//"postCreateCommand": "./.devcontainer/postCreateCommand.sh"
15
+
"postCreateCommand": "npm install",
16
16
17
17
// Configure tool-specific properties.
18
18
"customizations": {
···
21
21
"hbenl.vscode-mocha-test-adapter",
22
22
"dbaeumer.vscode-eslint"
23
23
]
24
+
}
25
+
},
26
+
"portsAttributes": {
27
+
"3000": {
28
+
"label": "Docusaurus"
29
+
},
30
+
"9078": {
31
+
"label": "App"
24
32
}
25
33
}
26
34
+10
-3
docsite/docs/development/dev-common.md
+10
-3
docsite/docs/development/dev-common.md
···
14
14
15
15
## Project Setup
16
16
17
-
Development requires [Node v18.19.1](https://nodejs.org/en) or higher is installed on your system. It is recommended to use [nvm](https://github.com/nvm-sh/nvm) to manage the installed node version.
17
+
Development requires [Node v18.19.1](https://nodejs.org/en) or higher is installed on your system.
18
+
19
+
:::tip
20
+
21
+
When running locally (not with a devcontainer) you can use [nvm](https://github.com/nvm-sh/nvm) to manage the installed node version.
22
+
23
+
:::
18
24
19
25
Clone this repository somewhere and then install from the working directory
20
26
21
27
```shell
22
28
git clone https://github.com/FoxxMD/multi-scrobbler.git .
23
29
cd multi-scrobbler
24
-
nvm use # optional, to set correct Node version
30
+
nvm use # optional, sets correct node version when running without devcontainer
25
31
npm install
26
32
npm run start
27
33
```
···
32
38
33
39
* Run/Debug [Launch configurations](https://code.visualstudio.com/Docs/editor/debugging#_launch-configurations) for the application and tests
34
40
* [Devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) for development with all dependencies already installed
41
+
* Useful extensions for linting and running tests
35
42
36
-
To use the Devcontainer simple open the repository in VSCode and "Use Devcontainer" when the notification is presented. You will still need to run `nvm use` and `npm install` the first time it is used.
43
+
To use the Devcontainer simple open the repository in VSCode and "Use Devcontainer" when the notification is presented. `npm install` will be run when a new container is created.
37
44
38
45
## Common Development
39
46