Skip to content

Commit cc5f45f

Browse files
committed
docs: update README with database setup instructions
1 parent d505bd0 commit cc5f45f

3 files changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ Install dependencies:
1010
uv sync --extra dev
1111
```
1212

13+
Run the database:
14+
15+
```bash
16+
docker compose up database
17+
```
18+
19+
Run database migrations:
20+
21+
```bash
22+
uv run alembic upgrade head
23+
```
24+
1325
Run the server:
1426

1527
```bash

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.1.0"
44
description = "REST API server for Papyrus, a cross platform book management application."
55
requires-python = ">=3.12"
66
license = { text = "AGPL-3.0" }
7-
authors = [{ name = "Papyrus Team" }]
7+
authors = [{ name = "Papyrus" }]
88
readme = "README.md"
99

1010
dependencies = [

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)