Here's the updated markdown with instructions for setting up a virtual environment:
Welcome to the documentation for the FastAPI Beyond CRUD course.
This repository contains the source code for the course website.
Before starting, make sure you have the following installed:
- Python 3.x
To set up the project, follow these steps:
-
Clone the repository:
git clone https://github.com/jod35/fastapi-beyond-crud-docs.git
-
Navigate into the project directory:
cd fastapi-beyond-crud-docs
-
Create a virtual environment:
- On macOS/Linux:
python3 -m venv venv
- On Windows:
python -m venv venv
- On macOS/Linux:
-
Activate the virtual environment:
- On macOS/Linux:
source venv/bin/activate
- On Windows:
venv\Scripts\activate
- On macOS/Linux:
-
Install the required dependencies:
pip install -r requirements.txt
-
Run the application:
mkdocs serve
Your application should now be up and running within the virtual environment.