backrest/CONTRIBUTING.md

Contributing

Commits

This repo uses Conventional Commits.

Dev Depedencies

Build Dependencies

• Node.JS for UI development
• Go 1.21 or greater for server development
• goreleaser go install github.com/goreleaser/goreleaser@latest

To Edit Protobuffers

apt install -y protobuf-compiler
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/bufbuild/buf/cmd/buf@v1.27.2
go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
npm install -g @bufbuild/protoc-gen-es @connectrpc/protoc-gen-connect-es

Building

(cd webui && npm i && npm run build)
(cd cmd/backrest && go build .)

Using VSCode Dev Containers

You can also use VSCode with Dev Containers extension to quickly get up and running with a working development and debugging environment.

0. Make sure Docker and VSCode with Dev Containers extension is installed
1. Clone this repository
2. Open this folder in VSCode
3. When propmpted, click on Open in Container button, or run > Dev Containers: Rebuild and Reopen in Containers command
4. When container is started, go to Run and Debug, choose Debug Backrest (backend+frontend) and run it

Provided launch configuration has hot reload for typescript frontend.