selfhostyourtech/reflector
2
0
Fork 0
mirror of https://github.com/Monadical-SAS/reflector.git synced 2025-12-20 12:19:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andreas
2023-12-18 20:42:36 +07:00
parent e9192770b5
commit a0392edaf9
1 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -114,12 +114,6 @@ Then fill `.env` with the omitted values (ask in Zulip). At the moment of this w
### Start the API/Backend ### Start the API/Backend
Start the server:
```bash
poetry run python -m reflector.app
```
Start the background worker: Start the background worker:
```bash ```bash
@@ -135,6 +129,14 @@ redis-server
### Redis (Windows) ### Redis (Windows)
**Option 1**
```bash
docker compose up -d redis
```
**Option 2**
Install: Install:
- [Git for Windows](https://gitforwindows.org/) - [Git for Windows](https://gitforwindows.org/)
- [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install) - [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install)
@@ -147,6 +149,20 @@ sudo apt install redis-server
redis-server redis-server
``` ```
## Update the database schema (run on first install, and after each pull containing a migration)
```bash
poetry run python alembic head
```
## Main Server
Start the server:
```bash
poetry run python -m reflector.app
```
### Crontab (optional) ### Crontab (optional)
For crontab (only healthcheck for now), start the celery beat (you don't need it on your local dev environment): For crontab (only healthcheck for now), start the celery beat (you don't need it on your local dev environment):