klbr/LetterFeed
1
0
Fork 0
mirror of https://github.com/khoaliber/LetterFeed.git synced 2026-03-02 13:18:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update readme with new make commands

Browse Source
This commit is contained in:
Leon
2025-07-16 22:36:08 +02:00
parent a3d42b51f4
commit cc9e2b2f1b
1 changed files with 20 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -30,10 +30,10 @@ LetterFeed is a self-hosted application that converts email newsletters into RSS
Edit the `.env` file with your specific settings. Edit the `.env` file with your specific settings.
3. **Build and run the Docker containers:** 3. **Run the Docker containers:**
```bash ```bash
docker compose up --build make docker-up
``` ```
### Behind a Reverse Proxy ### Behind a Reverse Proxy
@@ -115,22 +115,28 @@ networks:
## Development ## Development
### Frontend (Next.js) To run the application in development mode:
To run the frontend in development mode:
```bash ```bash
cd frontend make dev
npm install # or to run the dev container
npm run dev make docker-dev-up
``` ```
### Backend (FastAPI) To install dependencies:
To run the backend in development mode:
```bash ```bash
cd backend make install
uv sync --group test ```
uvicorn app.main:app --reload
To run tests:
```bash
make test
```
To lint the code:
```bash
make lint
``` ```