Skip to content

Docs: Add local run instructions to frontend README #2

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

Open
Mustansir-06 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Add local run instructions to frontend README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ This is a minimal, proof-of-concept frontend application for OpenRx, built with
- A simple local web server (e.g., Python's `http.server`, Node's `serve`, or a browser extension).
- The OpenRx backend must be running on `http://localhost:8000` (or the port you configure).

## 🚀 Running Locally (Node Development Server)

For typical development using Node.js tools:

1. Install the required dependencies:
```bash
npm install
```
2. Start the development server:
```bash
npm start
```

### Running the Frontend
1. Ensure the backend is running (see `backend/README.md`).
2. Navigate to the `frontend/` directory.
Expand Down