jellyfin/jellyfin-chromecast
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-chromecast.git synced 2025-02-17 04:59:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add instructions to "Building/Using" section of CONTRIBUTING

Browse Source
This commit is contained in:
YouKnowBlom 2021-07-04 23:21:25 +02:00
parent e39f2c036c
commit 928b037cb7
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -19,9 +19,25 @@ The development environment is setup with editorconfig. Code style is enforced b
### Building/Using
`npm run build:development` - Build a development version
`npm start` - Build a development version and start a dev server
`npm run build:production` - Build a production version
`npm run test` - Run tests
`npm run lint` - Run linting and prettier
1. Register a new [application](https://developers.google.com/cast/docs/registration). It is important that you choose a "Custom application", the rest of the details are up to you (name, description, etc). You will need a web server to host the files on.
2. Set up a local copy of [jellyfin-web](https://github.com/jellyfin/jellyfin-web).
3. Change `applicationStable` and `applicationUnstable` in `jellyfin-web/src/plugins/chromecastPlayer/plugin.js` to your own application ID.
4. Run the local copy of jellyfin-web using the provided instructions in the repo.
5. Clone this repo and run `npm install`. This will install all dependencies, run tests and build a production build by default.
6. Make changes and build with `npm run build:development`. `build:development` includes sourcemaps that'll make it easier to debug.
7. Before pushing your changes, make sure to run `npm run test` and `npm run lint`.
> NOTE: It is recommended to symlink the `dist` folder pointing to a location on your web server hosting the files. That way you can refresh the cast receiver via the Chrome Remote Debugger and see your changes without having to manually copy after each build.
## Pull Requests
This project uses the standard Github Fork and PR flow