Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jod35/fastapi-beyond-crud
This is source code for a series where we talk about the concepts of FastAPI API development beyond the CRUD stuff
https://github.com/jod35/fastapi-beyond-crud
fastapi sqlmodel
Last synced: 3 days ago
JSON representation
This is source code for a series where we talk about the concepts of FastAPI API development beyond the CRUD stuff
- Host: GitHub
- URL: https://github.com/jod35/fastapi-beyond-crud
- Owner: jod35
- Created: 2024-02-27T17:16:30.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-17T19:05:37.000Z (18 days ago)
- Last Synced: 2025-01-26T12:05:07.127Z (10 days ago)
- Topics: fastapi, sqlmodel
- Language: Python
- Homepage: https://jod35.github.io/fastapi-beyond-crud-docs/site/
- Size: 949 KB
- Stars: 170
- Watchers: 5
- Forks: 53
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FastAPI Beyond CRUD
This is the source code for the [FastAPI Beyond CRUD](https://youtube.com/playlist?list=PLEt8Tae2spYnHy378vMlPH--87cfeh33P&si=rl-08ktaRjcm2aIQ) course. The course focuses on FastAPI development concepts that go beyond the basic CRUD operations.
For more details, visit the project's [website](https://jod35.github.io/fastapi-beyond-crud-docs/site/).
## Table of Contents
1. [Getting Started](#getting-started)
2. [Prerequisites](#prerequisites)
3. [Project Setup](#project-setup)
4. [Running the Application](#running-the-application)
5. [Running Tests](#running-tests)
6. [Contributing](#contributing)
## Getting Started
Follow the instructions below to set up and run your FastAPI project.
### Prerequisites
Ensure you have the following installed:
- Python >= 3.10
- PostgreSQL
- Redis
### Project Setup
1. Clone the project repository:
```bash
git clone https://github.com/jod35/fastapi-beyond-CRUD.git
```
2. Navigate to the project directory:
```bash
cd fastapi-beyond-CRUD/
```
3. Create and activate a virtual environment:
```bash
python3 -m venv env
source env/bin/activate
```
4. Install the required dependencies:
```bash
pip install -r requirements.txt
```
5. Set up environment variables by copying the example configuration:
```bash
cp .env.example .env
```
6. Run database migrations to initialize the database schema:
```bash
alembic upgrade head
```
7. Open a new terminal and ensure your virtual environment is active. Start the Celery worker (Linux/Unix shell):
```bash
sh runworker.sh
```
## Running the Application
Start the application:
```bash
fastapi dev src/
```
Alternatively, you can run the application using Docker:
```bash
docker compose up -d
```
## Running Tests
Run the tests using this command
```bash
pytest
```
## Contributing
I welcome contributions to improve the documentation! You can contribute [here](https://github.com/jod35/fastapi-beyond-crud-docs).