diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..6dc687e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: maxdorninger +buy_me_a_coffee: maxdorninger \ No newline at end of file diff --git a/README.md b/README.md index 30c3339..b7dda5b 100644 --- a/README.md +++ b/README.md @@ -40,41 +40,6 @@ other services. docker compose up -d ``` -## Developer Quick Start - -```bash - pip install uv - uv venv - # Activate the virtual environment - uv pip install -e . -``` -```bash -docker compose up db -d -``` - -```bash -uv run alembic upgrade head -``` - -## Get the frontend up and running - -TODO: provide an env.example to copy - -```bash -cd /web && npm install -``` - -## Now start the backend and frontend -```bash -fastapi dev /media_manager/main.py --reload --host -``` - -```bash -cd /web && npm run dev -``` - - - ### [View the docs for installation instructions and more](https://maxdorninger.github.io/MediaManager/configuration-overview.html#configuration-overview) @@ -97,6 +62,9 @@ cd /web && npm run dev - [x] improve reliability of scheduled tasks - [x] add notification system - [x] add sequence diagrams to the documentation +- [ ] provide example configuration files +- [ ] make media sorting algorithm configurable +- [ ] add usenet support - [ ] add in-depth documentation on the architecture of the codebase - [ ] make indexer module multithreaded - [ ] add support for deluge and transmission @@ -116,6 +84,38 @@ See the [open issues](hhttps://maxdorninger.github.io/MediaManager/issues) for a ![Screenshot 2025-06-28 222908](https://github.com/user-attachments/assets/193e1afd-dabb-42a2-ab28-59f2784371c7) +## Developer Quick Start + +```bash + pip install uv + uv venv + # Activate the virtual environment + uv pip install -e . +``` +```bash +docker compose up db -d +``` + +```bash +uv run alembic upgrade head +``` + +### Get the frontend up and running + +```bash +cd /web && npm install +``` + +### Now start the backend and frontend +```bash +fastapi dev /media_manager/main.py --reload --host +``` + +```bash +cd /web && npm run dev +``` + + ## License