diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..a74af7ff --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +buy_me_a_coffee: garethgeorge +github: garethgeorge diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a02f4017..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,44 +0,0 @@ -# Contributing - -## Commits - -This repo uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). - -## Build Depedencies - -- [Node.js](https://nodejs.org/en) for UI development -- [Go](https://go.dev/) 1.21 or greater for server development -- [goreleaser](https://github.com/goreleaser/goreleaser) `go install github.com/goreleaser/goreleaser@latest` - -**To Edit Protobuffers** - -```sh -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 - -```sh -(cd webui && npm i && npm run build) -(cd cmd/backrest && go build .) -``` -To run the web UI after building, you can execute: `go run .` - -## Using VSCode Dev Containers - -You can also use VSCode with [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension to quickly get up and running with a working development and debugging environment. - -0. Make sure Docker and VSCode with [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension is installed -1. Clone this repository -2. Open this folder in VSCode -3. When prompted, 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 - -> [!NOTE] -> Provided launch configuration has hot reload for typescript frontend. diff --git a/README.md b/README.md index 8a4bf99d..f52c132f 100644 --- a/README.md +++ b/README.md @@ -253,3 +253,45 @@ To run the binary on login, create a shortcut to the binary and place it in the | `BACKREST_DATA` | Path to the data directory | `%appdata%\backrest\data` | | `BACKREST_RESTIC_COMMAND` | Path to restic binary | Defaults to a Backrest managed version of restic in `C:\Program Files\restic\restic-x.x.x` | | `XDG_CACHE_HOME` | Path to the cache directory | | + +# Contributing + +Contributions are welcome! See the [issues](https://github.com/garethgeorge/backrest/issues) or feel free to open a new issue to discuss a project. Beyond the core codebase, contributions to [documentation](https://garethgeorge.github.io/backrest/introduction/getting-started), [cookbooks](https://garethgeorge.github.io/backrest/cookbooks/command-hook-examples), and testing are always welcome. + +## Build Depedencies + +- [Node.js](https://nodejs.org/en) for UI development +- [Go](https://go.dev/) 1.21 or greater for server development +- [goreleaser](https://github.com/goreleaser/goreleaser) `go install github.com/goreleaser/goreleaser@latest` + +**(Optional) To Edit Protobuffers** + +```sh +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 +``` + +## Compiling + +```sh +(cd webui && npm i && npm run build) +(cd cmd/backrest && go build .) +``` + +## Using VSCode Dev Containers + +You can also use VSCode with [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension to quickly get up and running with a working development and debugging environment. + +0. Make sure Docker and VSCode with [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension is installed +1. Clone this repository +2. Open this folder in VSCode +3. When prompted, 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 + +> [!NOTE] +> Provided launch configuration has hot reload for typescript frontend.