This project is a REST API backend developed with Django, as part of an internship assignment.
The backend is developed in Django with Python. This project focuses on providing a set of RESTful APIs for handling courses, students, and instructors.
- Python 3.8+
- Django 4.2+
- PostgreSQL (or another database of choice)
- Docker (for containerization)
-
Clone the repository:
git clone https://github.com/yourusername/django-project.git cd django-project -
Create a virtual environment and activate it:
python -m venv env source env/bin/activate # On Windows use `env\Scripts\activate`
-
Install dependencies:
pip install -r requirements.txt
-
Set up the database:
python manage.py migrate
-
Run the development server:
.python manage.py runserver
6.Run .http://127.0.0.1:8000/
The following are the available API endpoints:
/api/courses/- List and create courses/api/courses/<id>/- Retrieve, update, and delete a course/api/students/- List and create students/api/students/<id>/- Retrieve, update, and delete a student
- Fork the repository.
- Create a new branch for your feature:
git checkout -b feature-name. - Commit your changes:
git commit -m "Description of feature". - Push to the branch:
git push origin feature-name. - Submit a pull request.
This project is licensed under the MIT License.
This project is built using Django and Python, with a virtual environment named myvenv. The backend APIs are structured to provide efficient data handling and processing for the application. All dependencies are managed using a .env file to ensure easy setup. Docker is used for containerization to simplify deployment. The project can be run locally using python manage.py runserver after activating the virtual environment. This repository includes clear setup instructions, API endpoints, and guidelines for contributing.