Skip to content

Commit 394611d

Browse files
committed
Update README
1 parent a4bf2cc commit 394611d

File tree

2 files changed

+39
-33
lines changed

2 files changed

+39
-33
lines changed

.github/workflows/tests-coverage.yml

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

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,40 @@
1-
# Example Project
1+
# Bolerplate FastAPI + Aiogram3 + Poetry Template Project
22

3-
FastAPI
4-
Aiogram 3
5-
SQLAlchemy
3+
* FastAPI
4+
* Aiogram 3
5+
* Poetry
6+
* Docker
7+
8+
## Quickstart
9+
10+
Copy example with required env variables
11+
```bash
12+
cp .env.example .env
13+
```
14+
15+
Get `BOT_TOKEN` from [BotFather](https://t.me/botfather) and set it in `.env` file and set `BASE_DOMAIN` for webhook.
16+
17+
18+
Your `.env` file should look like this:
19+
```.env
20+
BOT_TOKEN=6694236732:fvevftgvthjadafgvtvg
21+
BASE_DOMAIN=https://public-domain.example.com
22+
23+
APP_PORT=8000 # optional
24+
APP_HOST=0.0.0.0 # optional
25+
26+
```
27+
28+
### Run with poetry
29+
30+
```bash
31+
poetry install
32+
```
33+
34+
### Run with docker-compose
35+
```bash
36+
docker compose up --build
37+
38+
```
39+
40+
API will be available at `http://localhost:8000` by default.

0 commit comments

Comments
 (0)