README.md

FastAPI Beyond CRUD

This is the source code for the FastAPI Beyond CRUD course. The course focuses on FastAPI development concepts that go beyond the basic CRUD operations.

For more details, visit the project's website.

Table of Contents

1. Getting Started
2. Prerequisites
3. Project Setup
4. Running the Application
5. Running Tests
6. 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:

   git clone https://github.com/jod35/fastapi-beyond-CRUD.git

2. Navigate to the project directory:

   cd fastapi-beyond-CRUD/

3. Create and activate a virtual environment:

   python3 -m venv env
   source env/bin/activate

4. Install the required dependencies:

   pip install -r requirements.txt

5. Set up environment variables by copying the example configuration:

   cp .env.example .env

6. Run database migrations to initialize the database schema:

   alembic upgrade head

7. Open a new terminal and ensure your virtual environment is active. Start the Celery worker (Linux/Unix shell):

   sh runworker.sh

Running the Application

Start the application:

fastapi dev src/

Alternatively, you can run the application using Docker:

docker compose up -d

Running Tests

Run the tests using this command

pytest

Contributing

I welcome contributions to improve the documentation! You can contribute here.