mirror of
https://github.com/maxdorninger/MediaManager.git
synced 2026-04-17 15:13:24 +02:00
update readme
This commit is contained in:
2
.github/FUNDING.yml
vendored
Normal file
2
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
github: maxdorninger
|
||||||
|
buy_me_a_coffee: maxdorninger
|
||||||
70
README.md
70
README.md
@@ -40,41 +40,6 @@ other services.
|
|||||||
docker compose up -d
|
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)
|
### [View the docs for installation instructions and more](https://maxdorninger.github.io/MediaManager/configuration-overview.html#configuration-overview)
|
||||||
|
|
||||||
<!-- ROADMAP -->
|
<!-- ROADMAP -->
|
||||||
@@ -97,6 +62,9 @@ cd /web && npm run dev
|
|||||||
- [x] improve reliability of scheduled tasks
|
- [x] improve reliability of scheduled tasks
|
||||||
- [x] add notification system
|
- [x] add notification system
|
||||||
- [x] add sequence diagrams to the documentation
|
- [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
|
- [ ] add in-depth documentation on the architecture of the codebase
|
||||||
- [ ] make indexer module multithreaded
|
- [ ] make indexer module multithreaded
|
||||||
- [ ] add support for deluge and transmission
|
- [ ] add support for deluge and transmission
|
||||||
@@ -116,6 +84,38 @@ See the [open issues](hhttps://maxdorninger.github.io/MediaManager/issues) for a
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||
|
## 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 -->
|
<!-- LICENSE -->
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user