added contributing guidelines

This commit is contained in:
FrenchGithubUser
2025-10-03 18:51:39 +02:00
parent 11e601926f
commit 08455a92f5
2 changed files with 25 additions and 0 deletions

19
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,19 @@
Thanks for wanting to contribute to Dasharr !
## Quickstart :
- clone the repo
- start a postgresql database (the easiest way is with the one in `compose.yml`: `docker compose up db -d`)
- create `.env` files from the `.env.example` ones in `backend/` and `frontend/` and edit the values you want
- (optional, if you want to work on the frontend) install the frontend dependencies and run it: `cd frontend && npm install && npm run dev`
- install the backend dependencies and run it: `cd backend && cargo run`
- start coding !
## What to do ?
Looking for something to do ?
- Many indexers are still to be added
- Have a look at the issues of the repo
Don't hesitate to get in touch on `#dev` on the discord server (link in the README)

View File

@@ -37,3 +37,9 @@ We often times don't realize the evolution of the stats on torrent indexers, thi
* RED
</details>
## Want to help ?
- Have a look at [CONTRIBUTING.md](./CONTRIBUTING.md)
- Report issues you might have, suggest new features
- Hop on the discord server and let's chat