From 08455a92f561a78643537ca6775f0ca9022e3667 Mon Sep 17 00:00:00 2001 From: FrenchGithubUser Date: Fri, 3 Oct 2025 18:51:39 +0200 Subject: [PATCH] added contributing guidelines --- CONTRIBUTING.md | 19 +++++++++++++++++++ README.md | 6 ++++++ 2 files changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5b2100d --- /dev/null +++ b/CONTRIBUTING.md @@ -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) diff --git a/README.md b/README.md index 8f9a64f..261b9e0 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,9 @@ We often times don't realize the evolution of the stats on torrent indexers, thi * RED + +## 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