Skip to content

A DRF backend for farming stores handling products, orders, and inventory.

Notifications You must be signed in to change notification settings

raufzer/farmflow-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A Django REST Framework Backend for FarmFlow website.

FarmFlow backend is a robust backend API built using Django and Django REST Framework to power farming store applications. It provides a solid foundation for managing products, jobs, orders, inventory, and other essential farming-related data.

Features

  • Product Management: Create, read, update, and delete products with details like name, description, price, image, category, and availability.
  • Order Processing: Handle order creation, processing, payment, and delivery management.
  • Inventory Control: Track product stock levels, manage low stock alerts, and automate reordering processes.
  • User Authentication and Authorization: Implement secure user authentication and authorization mechanisms.

Technologies

  • Django: Python's high-level web framework for rapid development.
  • Django REST Framework: Powerful toolkit for building web APIs.
  • SQL lite: Robust and scalable database for storing application data.

Getting Started

Prerequisites

  • Python (version 3.12.4 or higher)
  • Django (version 5.07 or higher)
  • Django REST Framework (version 3.15.2 or higher)
  • SQLite (or other supported database)

Installation

  1. Clone the repository:
    git clone [the repo url]
  2. Create a virtual environment:
    python -m venv venv
    source venv/bin/activate  # or venv\Scripts\activate on Windows
  3. Install dependencies:
    pip install -r requirements.txt
  4. Configure database settings (update settings.py with your database credentials).
  5. Run migrations:
    python manage.py migrate
  6. Start the development server:
     python manage.py runserver
    

API Documentation

SOON.

Contributing

We welcome contributions to FarmFlow! Please refer to our contribution guidelines for details.

License

This project is licensed under the raufzer license.

About

A DRF backend for farming stores handling products, orders, and inventory.

Topics

Resources

Stars

Watchers

Forks