Giter Club home page Giter Club logo

fm_vendor_management_system's Introduction

Vendor Management System

Description

This is a simple vendor management system that allows users to add, edit, delete and view vendors. It also allows users to add, edit, delete and view purchase orders and track vendors' performance. The system is built using Django and Django REST framework.

Features

  • Add, edit, delete and view vendors
  • Add, edit, delete and view purchase orders

Technologies

  • Python
  • Django
  • Django REST framework
  • SQLite

Installation

  1. Clone the repository
git clone
  1. Create a virtual environment
python -m venv venv
  1. Install the requirements
pip install -r requirements.txt
  1. Run the migrations
python manage.py migrate
  1. Create .env file and copy the variables given in the .env.example file
  2. Run the server
python manage.py runserver

API Endpoints

  • /api/vendors/ - GET, POST
  • /api/vendors/{id}/ - GET, PUT, DELETE
  • /api/purchase-orders/ - GET, POST
  • /api/purchase-orders/{id}/ - GET, PUT, DELETE
  • /api/vendors/{id}/performance - GET

Project Structure

  • vendors - Django app for related models
  • purchase_orders - Django app for related models
  • common - Django app for helper functions and boilerplate
  • analytics - Django app for performance tracking models
  • api - Django app for API views, serializers, urls and services

Patterns Followed

  • SRP (Single Responsibility Principle) - Each class and function has a single responsibility
  • DRY (Don't Repeat Yourself) - Repeated code is refactored into helper functions
  • KISS (Keep It Simple, Stupid) - Code is simple and easy to understand
  • YAGNI (You Aren't Gonna Need It) - Only necessary features are implemented
  • Beautiful is better than ugly - Code is clean and readable (ZEN of Python)
  • Readability counts - Code is easy to read and understand (ZEN of Python)

Authentication Method Used

  • Custom token-based authentication : Token is generated when a user is created and is used to authenticate the user for all API requests (But for this MVP, the Token is generated using a Custom Random String stored in .env file and is used for all users)

fm_vendor_management_system's People

Contributors

ambar-06 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.