An open API service indexing awesome lists of open source software.

https://github.com/mariamkipshidze/fastapi-learning-series

🚀 A simple FastAPI project for learning and experimenting with building APIs using Python. Created as part of my web development practice
https://github.com/mariamkipshidze/fastapi-learning-series

fastapi python

Last synced: about 1 month ago
JSON representation

🚀 A simple FastAPI project for learning and experimenting with building APIs using Python. Created as part of my web development practice

Awesome Lists containing this project

README

          

## 🚀 Getting Started

### 1. Clone the Repository
```bash
git clone https://github.com/MariamKipshidze/fastapi-learning-series.git
````

### 2. Create and Activate a Virtual Environment (optional but recommended)

```bash
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate
```

### 3. Install Dependencies

```bash
pip install -r requirements.txt
```

If `requirements.txt` doesn't exist yet, install FastAPI and Uvicorn manually:

```bash
pip install fastapi[all] uvicorn
```

### 4. Run the Application

```bash
uvicorn main:app --reload
```

### 5. Create and run Migrations

```bash
alembic revision --autogenerate -m "Comment"
```
```bash
alembic upgrade head
```

This will start the development server at `http://127.0.0.1:8000/`

Interactive API docs - `http://127.0.0.1:8000/docs`

Alternative API docs - `http://127.0.0.1:8000/redoc`