polaris-mirror/docs/CONTRIBUTING.md

Contributing

Compiling and Running Polaris

Compiling and running Polaris is very easy as it only depends on the Rust toolchain.

1. Install Rust
2. Clone the polaris depot with this command: git clone --recursive https://github.com/agersant/polaris.git
3. You can now run compile and run polaris from the newly created directory with the command: cargo run

Polaris supports a few command line arguments which are useful during development:

• -c some/config.toml sets the location of the configuration file. This is useful to preconfigure users and music directories.
• --data some/path sets the folder Polaris will use to store runtime data such as playlists, collection index and auth secrets.
• -w some/path/to/web/dir lets you point to the directory to be served as the web interface. You can find a suitable directory in your Polaris install (under /web), or from the latest polaris-web release.
• -f (on Linux) makes Polaris not fork into a separate process.

Putting it all together, a typical command to compile and run the program would be: cargo run -- -w web -c test-config.toml

While Polaris is running, access the web UI at http://localhost:5050.

Running Unit Tests

That's the easy part, simply run cargo test!