diff --git a/docs/docs/help-out/contribute.md b/docs/docs/help-out/contribute.md deleted file mode 100644 index 27c202e..0000000 --- a/docs/docs/help-out/contribute.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: contribute ---- - -# Contributing - -I am happy that you want to contribute to Pocket ID and help to make it better! All contributions are welcome, including issues, suggestions, pull requests and more. - -## Getting started - -You've found a bug, have suggestion or something else, just create an issue on GitHub and we can get in touch. - -## Submit a Pull Request - -Before you submit the pull request for review please ensure that - -- The pull request naming follows the [Conventional Commits specification](https://www.conventionalcommits.org): - - `[optional scope]: ` - - example: - - ``` - feat(share): add password protection - ``` - - Where `TYPE` can be: - - - **feat** - is a new feature - - **doc** - documentation only changes - - **fix** - a bug fix - - **refactor** - code change that neither fixes a bug nor adds a feature - -- Your pull request has a detailed description -- You run `npm run format` to format the code - -## Setup project - -Pocket ID consists of a frontend, backend and a reverse proxy. - -### Backend - -The backend is built with [Gin](https://gin-gonic.com) and written in Go. - -#### Setup - -1. Open the `backend` folder -2. Copy the `.env.example` file to `.env` and change the `APP_ENV` to `development` -3. Start the backend with `go run cmd/main.go` - -### Frontend - -The frontend is built with [SvelteKit](https://kit.svelte.dev) and written in TypeScript. - -#### Setup - -1. Open the `frontend` folder -2. Copy the `.env.example` file to `.env` -3. Install the dependencies with `npm install` -4. Start the frontend with `npm run dev` - -You're all set! - -### Reverse Proxy -We use [Caddy](https://caddyserver.com) as a reverse proxy. You can use any other reverse proxy if you want but you have to configure it yourself. - -#### Setup -Run `caddy run --config reverse-proxy/Caddyfile` in the root folder. - -### Testing - -We are using [Playwright](https://playwright.dev) for end-to-end testing. - -The tests can be run like this: -1. Start the backend normally -2. Start the frontend in production mode with `npm run build && node build/index.js` -3. Run the tests with `npm run test` diff --git a/docs/sidebars.ts b/docs/sidebars.ts index d1dbfa5..dfea5b2 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -87,8 +87,9 @@ const sidebars: SidebarsConfig = { label: "Helping Out", items: [ { - type: "doc", - id: "help-out/contribute", + type: "link", + label: "Contributing", + href: "https://github.com/stonith404/pocket-id/blob/main/CONTRIBUTING.md", }, ], },