Skip to content

Commit 86c6d3e

Browse files
committed
feat: update .env.example and readme
1 parent 0bff8f1 commit 86c6d3e

File tree

3 files changed

+16
-21
lines changed

3 files changed

+16
-21
lines changed

.env.example

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
DEBUG=True
22

3-
PROJECT_NAME="My app"
3+
PROJECT_NAME="VALORY.API"
44
VERSION="1.0.0"
55

6-
DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5432/valory"
7-
DEBUG_DATABASE_URL="sqlite+aiosqlite:///sqlite.db"
6+
DATABASE_LOGIN=""
7+
DATABASE_PASSWORD=""
8+
DATABASE_PORT=5432
9+
DATABASE_NAME=""

backend/Pipfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ uvicorn = "*"
1919
[dev-packages]
2020

2121
[requires]
22-
python_version = "3.13"
22+
python_version = ">=3.12"
2323

2424
[scripts]
2525
dev = "fastapi dev main.py"

backend/readme.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,7 @@
1111
To run the backend, you will need the following dependencies installed:
1212

1313
- **Python 3.12+**: Core language for the backend.
14-
- **Package Manager**: [**uv**](https://github.com/yaqwsx/uv), a lightweight dependency manager for Python projects.
15-
16-
### Install dependencies
17-
Run the following command to set up your environment:
18-
```bash
19-
uv install
20-
```
21-
22-
This will automatically install all required dependencies listed in `uv.lock`.
14+
- **Package Manager**: [**Pipenv**](https://pipenv.pypa.io/en/latest/), a lightweight dependency manager for Python projects.
2315

2416
---
2517

@@ -55,24 +47,25 @@ These dependencies are automatically installed with the `uv install` command as
5547
```
5648
2. Install dependencies:
5749
```bash
58-
uv install
50+
pipenv install
5951
```
6052

6153
3. Create a .env file to configure environment variables. Example:
6254
```env
6355
DEBUG=True
6456
65-
PROJECT_NAME="My app"
66-
VERSION="1.0.0"
67-
68-
DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5432/"
69-
DEGUB_DATABASE_URL="sqlite+aiosqlite:///sqlite.db"
57+
PROJECT_NAME="VALORY.API"
58+
VERSION="1.0.0"
59+
60+
DATABASE_LOGIN=""
61+
DATABASE_PASSWORD=""
62+
DATABASE_PORT=5432
63+
DATABASE_NAME=""
7064
```
7165

7266
4. Run the Application
7367
```bash
74-
uv sync
75-
uv run main.py
68+
pipenv run dev
7669
```
7770

7871
---

0 commit comments

Comments
 (0)