Skip to content

docs: update README to reflect frontend runs locally, not in Docker #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: do
Choose a base branch
from
Draft

docs: update README to reflect frontend runs locally, not in Docker #51

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14b0543
Initial plan
Copilot Feb 26, 2026
047a294
docs: update README to reflect frontend running locally instead of Do…
Copilot Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,25 +70,39 @@ We won't spam you about trailing spaces. We only speak up when there's a real ri
| **Prevents Downtime?** | ❌ | ❌ | ✅ **YES** |

---
## Running with Docker
## Running the App

### Frontend (Local)

Prerequisites:
- Node.js 20+

```bash
cd frontend
npm install
npm run dev # Runs on http://localhost:5173
```

### Backend (Docker)

Prerequisites:

- Docker
- Docker Compose

### Creating the image
#### Creating the image
```bash
docker compose up --build
```

### Running the container
#### Running the container
```bash
docker compose up
docker compose up
```
### Stopping the container

#### Stopping the container
```bash
docker compose down
docker compose down
```
### 🤝 Join the School

Expand Down