Skip to content

Commit

Permalink
feat: update .env.example and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
haxgun committed Dec 6, 2024
1 parent 0bff8f1 commit 86c6d3e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 21 deletions.
8 changes: 5 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
DEBUG=True

PROJECT_NAME="My app"
PROJECT_NAME="VALORY.API"
VERSION="1.0.0"

DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5432/valory"
DEBUG_DATABASE_URL="sqlite+aiosqlite:///sqlite.db"
DATABASE_LOGIN=""
DATABASE_PASSWORD=""
DATABASE_PORT=5432
DATABASE_NAME=""
2 changes: 1 addition & 1 deletion backend/Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ uvicorn = "*"
[dev-packages]

[requires]
python_version = "3.13"
python_version = ">=3.12"

[scripts]
dev = "fastapi dev main.py"
27 changes: 10 additions & 17 deletions backend/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,7 @@
To run the backend, you will need the following dependencies installed:

- **Python 3.12+**: Core language for the backend.
- **Package Manager**: [**uv**](https://github.com/yaqwsx/uv), a lightweight dependency manager for Python projects.

### Install dependencies
Run the following command to set up your environment:
```bash
uv install
```

This will automatically install all required dependencies listed in `uv.lock`.
- **Package Manager**: [**Pipenv**](https://pipenv.pypa.io/en/latest/), a lightweight dependency manager for Python projects.

---

Expand Down Expand Up @@ -55,24 +47,25 @@ These dependencies are automatically installed with the `uv install` command as
```
2. Install dependencies:
```bash
uv install
pipenv install
```

3. Create a .env file to configure environment variables. Example:
```env
DEBUG=True
PROJECT_NAME="My app"
VERSION="1.0.0"
DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5432/"
DEGUB_DATABASE_URL="sqlite+aiosqlite:///sqlite.db"
PROJECT_NAME="VALORY.API"
VERSION="1.0.0"
DATABASE_LOGIN=""
DATABASE_PASSWORD=""
DATABASE_PORT=5432
DATABASE_NAME=""
```

4. Run the Application
```bash
uv sync
uv run main.py
pipenv run dev
```

---
Expand Down

0 comments on commit 86c6d3e

Please sign in to comment.