Development environment¶

If you would like to contribute to the project, you need a working development environment from RotorHazard. After setting up the development environment, you can follow the steps below to start developing the stream overlays.

Are you not a coder? But would you like to share ideas for new features? Then join the discussions and we will work out some sketches together.

Plugin code¶

Fork and Clone the repository to your local machine

Create a symlink from the stream_overlays folder to the RotorHazard plugin folder

ln -s ~/rh-stream-overlays/stream_overlays/ ~/RotorHazard/src/server/plugins/stream_overlays

Start or restart RotorHazard
You can now start developing 😄

Documentation¶

The documentation is built with MkDocs and hosted on GitHub Pages. The documentation is written in Markdown and can be found in the docs folder. This Python project relies on UV as its dependency manager, providing comprehensive management and control over project dependencies.

To make changes to the documentation, you need to set up a local development environment. This will allow you to preview your changes before pushing them to the repository.

Fork and Clone the repository to your local machine
Run the following commands to install the dependencies
```
uv sync --all-groups
```
Start the documentation server
```
uv run mkdocs serve
```
Open the application in your browser
```
http://localhost:8000
```