/Django-REST-Vendor-Management-System

AI based resume scanning website to enhance and create an ATS friendly resume

Primary LanguagePython

Django Application - Vendor Management System with Performance Metrics

This is a well-structured Django application designed to streamline your development workflow. It provides a solid foundation for building robust and scalable web applications.

Prerequisites

Python 3.7.6 or higher (latest recommended): Install it from https://www.python.org/downloads/.

Git version control system: Download and install it from https://git-scm.com/downloads.

Installation

Clone the repository:

Bash

git clone https://github.com/your-username/[your-app-name].git
cd [your-app-name]

Install dependencies:

Bash

pip install -r requirements.txt

This command installs all the required Python packages listed in the requirements.txt file.

Project Structure

vendormanagement/
├── manage.py # Main Django management script
├── vendormanagement/ # vendormanagement directory
│ ├── admin.py # Admin site configuration
│ ├── asgi.py # App configuration
│ ├── wsgi.py # App configuration
│ ├── init.py # Empty file to mark the directory as a package
│ ├── settings.py # Serializers for data serialization/deserialization
│ └── urls.py # Definition of your app's models
├── api/ # API directory │ ├── init.py # Empty file to mark the directory as a package
│ ├── urls.py # Definition of your app's models
│ ├── serializers.py # Serializers for data serialization/deserialization
│ ├── test_views.py # Unit and integration tests for your app
│ └── views.py # Definition of your app's views (functions)
├── base/ # Your base directory
│ ├── admin.py # Admin site configuration
│ ├── apps.py # App configuration (optional)
│ ├── init.py # Empty file to mark the directory as a package
│ ├── migrations/ # Migration files for your app's models
│ ├── models.py # Definition of your app's models
│ ├── tests.py # Unit and integration tests for your app
│ └── views.py # Definition of your app's views (functions)
├── README.md # This file (project documentation)
└── requirements.txt # File listing required Python packages

Usage

  1. Setting up the database:

Using the default database so no setup is needed

  1. Running migrations:

Apply database schema changes from your app's models to the actual database:

Bash
python manage.py makemigrations
python manage.py migrate

  1. Starting the development server:

Launch the Django development server:

Bash
python manage.py runserver

This will start the server, typically at http://127.0.0.1:8000/.

  1. Administrative interface:

Access the Django admin interface at http://127.0.0.1:8000/admin/.

You'll need to create a superuser account first using:

Bash
python manage.py createsuperuser

Testing

The application should have unit and integration tests written in the tests.py file of your app directory. To run them, use:

Bash
python manage.py test

License

This project is licensed under the MIT License.