Welcome to the Student Management CRUD API, a simple backend built with FastAPI, designed to manage student data effortlessly.
Start by cloning the project repository to your local machine:
git clone https://github.com/mtbaloch/daytwo.git
cd daytwo
To manage dependencies, create a virtual environment:
# Create a virtual environment on windows
# Create environment - here last env is the virtual environment name
python -m venv env
# Activate environment - here last env is the virtual environment name
env\Scripts\activate
# Create a virtual environment on macOS/Linux
# Create environment - here last env is the virtual environment name
python3 -m venv env
# Activate environment - here last env is the virtual environment name
source env\bin\activate
Install all the required dependencies using the requirements.txt
file:
pip install -r requirements.txt
Copy the example .env
file and create your own .env
file:
cp .env.example .env
Edit the .env
file to configure your environment variables with your own secret values but don't change keys.
Start the FastAPI server using:
fastapi dev app/
This will start the server, and you can access the API locally.
Here are the endpoints for testing the API:
- Swagger UI: http://127.0.0.1:8000/docs
- ReDoc: http://127.0.0.1:8000/redoc