playnite-web-app • Docs
playnite-web-app / contributing/development-environment/index
There are a few options for running Playnite Web for local development. Choose a path and follow its corresponding guide. Then, return to continue the next section.
- Local environment: use your local machine as the development environment. This requires installing more software than the number 2, but may have a smoother experience.
- GitHub code spaces.
- dev container.
| Application | Command | Notes |
|---|---|---|
| Playnite Web App | yarn run start |
Run Playnite Web application locally. Navigate to http://localhost:3000 in a browser. Environment variables are pulled from ./apps/playnite-web/local.env. |
| Playnite Web App | yarn run test/components |
Run component tests for development. |
| Playnite Web App | yarn run test/components/update |
Run component tests with intention to update a baseline screenshot. |
| Playnite Web App | yarn yarn run test/e2e |
Run end-to-end (e2e) tests for development (including visual regression capabilities). A consistent database restored along with consistent game assets. This ensures a reliable data set to test against. |
| Playnite Web App | yarn yarn run test/e2e/update |
Run end-to-end (e2e) tests with intention to update a baseline screenshot. |
To develop the Playnite Web plugin, a Windows machine is required. Playnite must be installed. Recommendation is to use Visual Studio Community edition for development.
- Install required software
- Playnite
- Visual Studio
- Open the solution file in Visual Studio; located in
apps/PlayniteWebPlugin/src/PlayniteWeb.sln. - Build the solution.
- Open Playnite and add the path to the bin directory as a local plugin. This setting is found under the Developer section in the settings.
- Debugging opens Playnite with the plugin installed.