Skip to content

Commit

Permalink
docs(backend): update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
haxgun committed Dec 3, 2024
1 parent 72ba508 commit f4347d5
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions backend/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ uv install

This will automatically install all required dependencies listed in `uv.lock`.

---

## 📦 Key Dependencies

The backend uses the following libraries to ensure seamless functionality and robust performance:
Expand All @@ -41,6 +43,8 @@ The backend uses the following libraries to ensure seamless functionality and ro

These dependencies are automatically installed with the `uv install` command as specified in the `uv.lock` file.

---

## 🛠 General Workflow

### 1. **Setup Environment**
Expand Down Expand Up @@ -71,6 +75,8 @@ These dependencies are automatically installed with the `uv install` command as
uv run uvicorn main:app --reload
```

---

## 🛡 API Documentation

The backend provides an auto-generated, interactive API documentation accessible at:
Expand Down

0 comments on commit f4347d5

Please sign in to comment.