Skip to content

One self-hosted app for your shows, movies and music.

1.2 KB
Raw Blame

title: Develop HolyArrs description: Build HolyArrs from source, find where code lives, run the checks, call the API and cut a release. level: Expert sidebar: { order: 0, label: "Develop" }

Build HolyArrs from source, change it in the right place and check the change before you send it.

Make your first change

Do these in order.

  1. Setup: install the tools, build the program and open it on port 6262.
  2. Contributing: make a change and open a pull request.
  3. Testing: run the checks that CI runs.

Learn the code

  • Architecture: the folder map, the data files and the rules that keep modules apart.
  • Modules: what each of the 20 modules owns, the layer order and the structure checks.

Build on HolyArrs

  • The HolyArrs API: make a key and call the JSON API, or run your own metadata server.
  • API routes: every route with the permission it needs.

Maintainers

  • Releasing: release notes, the update list, the image and taking a release back.

Related