Skip to content

jod35/fastapi-beyond-crud-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Here's the updated markdown with instructions for setting up a virtual environment:

FastAPI Beyond the CRUD Stuff

Welcome to the documentation for the FastAPI Beyond CRUD course.

Table of Contents

Introduction

This repository contains the source code for the course website.

Prerequisites

Before starting, make sure you have the following installed:

  • Python 3.x

Project Setup

To set up the project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/jod35/fastapi-beyond-crud-docs.git
  2. Navigate into the project directory:

    cd fastapi-beyond-crud-docs
  3. Create a virtual environment:

    • On macOS/Linux:
      python3 -m venv venv
    • On Windows:
      python -m venv venv
  4. Activate the virtual environment:

    • On macOS/Linux:
      source venv/bin/activate
    • On Windows:
      venv\Scripts\activate
  5. Install the required dependencies:

    pip install -r requirements.txt
  6. Run the application:

    mkdocs serve

Your application should now be up and running within the virtual environment.