<<<<<<< HEAD
=======
This is a simple CRUD API built using FastAPI for managing student records.
- Create, read, update, and delete student records.
- Filter students by department and gender.
- PostgreSQL database backend.
- Streamlit app for user-friendly interaction.
-
Clone the repository:
git clone https://github.com/Indirajith-jithu/student_management.git cd student_management
-
Install dependencies:
pip install -r requirements.txt
-
Set up the PostgreSQL database:
- Make sure PostgreSQL is installed and running on your system.
- Create a new database and update the connection string in
main.py
-
Run the FastAPI server:
python main.py
-
Access the API at
http://localhost:8000
and API DOC athttp://localhost:8000/docs
.
- Use the provided Streamlit app for a user-friendly interface to interact with the API.
- Use API endpoints directly for programmatic access.
POST /students/
: Create a new student record.GET /students/
: Get all student records.GET /students/{student_id}
: Get a specific student record.PUT /students/{student_id}
: Update a student record.DELETE /students/{student_id}
: Delete a student record.
To run the Streamlit app:
-
Install Streamlit if you haven't already:
pip install streamlit
-
Run the app:
streamlit run frontend.py
-
Access the app at
http://localhost:8501
.
Contributions are welcome! Please fork the repository and create a pull request with your changes.
This project is licensed under the MIT License. See the LICENSE file for details.
master