local-environment.md

playnite-web-app • Docs

---

playnite-web-app / contributing/development-environment/local-environment

Developer Environment: Local

Required Software

Install the following software on your local development machine:

1. git
2. Bash (this guide assumes a bash shell)
3. vscode
4. Docker (for Mongodb and MQTT dependencies)
5. Node.js@>=22.10.0 (recommend using nvm to manage Node.js installations)
   • nvm for OSX
   • nvm for Windows
6. yarn@^4.0.0
   • With Node.js installed, run corepack enable && corepack prepare --activate yarn@^4.5.1 && yarn set version 4.5.1

Preparing Codebase

1. Fork the playnite-web repo
2. Clone your forked repo to your local development machine.
3. Open the repo in vscode.
4. Run yarn
5. Run yarn nx run devenv:prepare. This is only required for the first time working with the codebase.
6. Run yarn run start and navigate to http://localhost:3000
   • Note that MQTT and Mongo will be started via docker automatically.
   • Mongo will restore a default database if no database already exists (if there are no files in .data/mongodb).
   • Note MQTT currently starts with no username/password configured.
7. [Optional]: override environment variables when running locally via cp apps/playnite-web/local.env apps/playnite-web/overrides.env
   • REMEMBER: do not commit overrides.env or sensitive information in local.env.
8. Continue to see commands for running tests.