Contributing

Skipperu is open source under the MIT license. The code lives at github.com/Godwindev1/Skipperu.

Prerequisites

• Node.js 22
• .NET 9 SDK

Get the code

git clone https://github.com/Godwindev1/Skipperu.git
cd Skipperu

Run it

Build the web app, then start the backend, which serves the built app alongside the API:

cd Skipperu.Web && npm ci && npm run build
cd ../Skipperu.backend && dotnet run

Open http://localhost:5757.

For frontend work, run the backend as above and, in another terminal, start the Vite dev server. It proxies /api to http://localhost:5757:

cd Skipperu.Web
npm run dev

Project layout

Folder	Contents
Skipperu.Web	React frontend
Skipperu.backend	.NET proxy and OpenAPI importer
Skipperu.desktop	Desktop app wrapper
Skipperu.Tests	Backend tests
docs	Design and planning notes
scripts	Publish scripts
.github/workflows	CI, Docker and desktop release workflows

Tests

cd Skipperu.Web && npm test
dotnet test ./Skipperu.Tests/Skipperu.Tests.csproj -c Release

CI runs both on every push and pull request to master. The frontend also has a linter: npm run lint in Skipperu.Web.

Releases

Releases are built by GitHub Actions from commits on master when a tag is pushed.

Tag	Publishes
docker-vX.Y.Z	Docker image to GHCR (X.Y.Z, latest, short SHA)
desktop-vX.Y.Z	Windows installer attached to a GitHub Release

git tag docker-v1.0.0 && git push origin docker-v1.0.0

Pull requests

Before opening a pull request:

• Make sure npm test, npm run lint and dotnet test pass.
• Keep the change focused on one thing.
• Describe what changed and why.

Bugs and ideas are welcome on the issue tracker.