Skip to content

Commit d4dc7e2

Browse files
authored
Merge pull request #3 from Ifechukwu001/patch/update-readme
Update README.md
2 parents b15421c + 75df9c5 commit d4dc7e2

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,43 @@ Developers Foundry Wallet User Service System
44

55
 
66
[![Version: v1.2.0](https://img.shields.io/badge/api-v1.2.0-blue?style=flat&logo=money)](CHANGELOG.md)
7+
8+
---
9+
10+
## OpenAPI/Swagger Documentation
11+
12+
The Swagger documentation for the application is hosted on [Render](https://df-user-service.onrender.com/api/docs) along with the application server.
13+
14+
## Setup
15+
16+
- Clone the repository
17+
18+
```bash
19+
git clone https://github.com/Ifechukwu001/finapp.git finapp
20+
cd finapp
21+
```
22+
23+
- Setup UV. \
24+
[Click to Install UV](https://docs.astral.sh/uv/getting-started/installation/)
25+
26+
- Synchronize the package requirements
27+
28+
```bash
29+
uv sync
30+
```
31+
32+
- Setup environment variables \
33+
You can use .env file in the root directory to configure the variables \
34+
_See the example in [ENV Example](.env.example)_
35+
36+
- Run migrations
37+
38+
```bash
39+
uv run manage.py migrate --database pg
40+
```
41+
42+
- Run the server locally on port 8000
43+
44+
```bash
45+
uv run manage.py runserver 8000
46+
```

0 commit comments

Comments
 (0)