Skip to content

Commit f32c159

Browse files
Dora455tjzel
andauthored
Clean up docs and set up Sphinx theme (#235)
Removed outdated core.rst file, added sphinx_rtd_theme to requirements.txt and updated frontend/README.md with latest info. --------- Co-authored-by: Tomasz Żelawski <[email protected]>
1 parent 147df6d commit f32c159

File tree

3 files changed

+28
-131
lines changed

3 files changed

+28
-131
lines changed

backend/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,6 @@ pytest-asyncio==0.26.0
4242
daphne==4.2.0
4343

4444
whitenoise==6.9.0
45+
46+
#docs
47+
sphinx_rtd_theme==3.0.2

docs/core.rst

Lines changed: 0 additions & 125 deletions
This file was deleted.

frontend/README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,36 @@
11
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
22

3+
## Production Build & Run
4+
5+
To run the project in production mode:
6+
7+
1. Go to the frontend directory and install dependencies:
8+
9+
```bash
10+
cd frontend
11+
npm install
12+
```
13+
14+
2. Build the project:
15+
16+
```bash
17+
npm run build
18+
```
19+
20+
3. Start the Next.js server:
21+
22+
```bash
23+
npm run start
24+
```
25+
26+
The production server will run at [http://localhost:3030](http://localhost:3030).
27+
328
## Getting Started
429

530
First, run the development server:
631

732
```bash
833
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1534
```
1635

1736
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

0 commit comments

Comments
 (0)