https://github.com/ali-jaan-butt/django-rest-api
Web based project using Python django backend framework. MongoDB is used as the database of the website and the data is shared through the api which is created by ourselves using python.
https://github.com/ali-jaan-butt/django-rest-api
api django django-api django-application django-framework mongodb python rest-api
Last synced: 4 months ago
JSON representation
Web based project using Python django backend framework. MongoDB is used as the database of the website and the data is shared through the api which is created by ourselves using python.
- Host: GitHub
- URL: https://github.com/ali-jaan-butt/django-rest-api
- Owner: Ali-Jaan-Butt
- License: mit
- Created: 2024-06-14T14:51:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-23T05:27:45.000Z (10 months ago)
- Last Synced: 2025-02-24T11:14:05.483Z (4 months ago)
- Topics: api, django, django-api, django-application, django-framework, mongodb, python, rest-api
- Language: HTML
- Homepage:
- Size: 9.47 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Project
This is a Django project that provides a web application for companies to post internship opportunities for graduated people and for students. In this project we make an api for the internship data from the database. This README file contains instructions for setting up and running the project.
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Running the Project](#running-the-project)
- [Testing](#testing)
- [Explainable AI Integration](#explainable-ai-integration)
- [License](#license)
- [Contact](#contact)
## Installation
### Prerequisites
Before you begin, ensure you have met the following requirements:
- Python (version 3.11 or later)
- pip (Python package installer)
- Virtualenv (optional but recommended)
### Steps
1. **Clone the repository:**
```bash
git clone https://github.com/Ali-Jaan-Butt/Django-rest-api.git
2. **Installations:**
Install all the libraries required specially Django using pip.
```bash
pip install Django
pip install pymongo
pip install smtplib
pip install fastapi
pip install sentence_transformers
pip install requests
4. **Connect Database:**
Install MongoDB GUI on your system and then run
```bash
cd db
mongod --dbpath ./
## Configuration
### Check all the requirements installed or not.
### You need to be in root directory in terminal where "manage.py" file is located.
## Running the project
### To run project we should have to run the server.
Be in the root directory where the manage.py file is located, then
1. **Run Server**
```bash
python manage.py runserver
## Testing
### You can test the project by using the website at locsl host: "http://127.0.0.1:8000"
## Explainable AI integration
### I have also integrated AI in it which is cosine text similarity for checking the similarity between the student tags and company internships description. So that right internship will reach to the right person.
## Licence
### Having MIT licence to this project
## Contact
- **Name:** Ali Jaan Butt
- **Email:** [email protected]
- **Phone:** +923201540500