Skip to content

mtbaloch/daytwo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation


🚀 Student Management CRUD API

Welcome to the Student Management CRUD API, a simple backend built with FastAPI, designed to manage student data effortlessly.

🛠️ How to Set Up the Project

1️⃣ Clone the Repository

Start by cloning the project repository to your local machine:

git clone https://github.com/mtbaloch/daytwo.git
cd  daytwo

2️⃣ Create and Activate a Virtual Environment

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

3️⃣ Install Dependencies

Install all the required dependencies using the requirements.txt file:

pip install -r requirements.txt

4️⃣ Set Up Environment Variables

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.


5️⃣ Run the Server

Start the FastAPI server using:

fastapi dev app/

This will start the server, and you can access the API locally.


🔗 URLs for Testing

Here are the endpoints for testing the API:


📢 Follow Me

Follow for updates, tips, and more:
LinkedIn

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages