Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Firebird1029 committed Mar 11, 2024
1 parent c79b068 commit e7a5fe6
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
# README

## Installation

To install the backend Python packages:

```bash
cd backend && pip install -r requirements.txt && cd -
```

To install the frontend NPM packages:

```bash
cd frontend && npm install && cd -
```

## Backend

To run the backend server:

```bash
cd backend
FLASK_APP=server flask run
flask --app server run --debug
```

To lint the backend code:
Expand Down Expand Up @@ -41,3 +55,7 @@ To access the frontend application:
```plaintext
localhost:3000
```

## Misc

To save a Python package to `backend/requirements.txt`, use `pigar`: `pip install pigar` then `pigar generate`.

0 comments on commit e7a5fe6

Please sign in to comment.