mirror of
https://github.com/nikdoof/pocket-id.git
synced 2025-12-14 15:22:18 +00:00
docs: remove duplicate contribute.md
This commit is contained in:
@@ -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):
|
|
||||||
|
|
||||||
`<type>[optional scope]: <description>`
|
|
||||||
|
|
||||||
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`
|
|
||||||
@@ -87,8 +87,9 @@ const sidebars: SidebarsConfig = {
|
|||||||
label: "Helping Out",
|
label: "Helping Out",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
type: "doc",
|
type: "link",
|
||||||
id: "help-out/contribute",
|
label: "Contributing",
|
||||||
|
href: "https://github.com/stonith404/pocket-id/blob/main/CONTRIBUTING.md",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user