කෘෂි අරුණලු | Krushi Arunalu

Purchase and Sales Management System for Agri and Crop Products

Current version: v0.4

🌐 Visit deployment

---

Table of Contents

1. About the project
   • Project at a glance
   • High level process
2. Group details
3. Technologies
   • Tech Stack
   • Built with
   • Libraries used
4. Getting started
   • Prerequisites
   • Downloading
   • Installing and executing (dev)
5. File Structure
6. License

🔰 About the project

Krushi Arunalu is a web based Purchase and Sales Management System for Agri and Crop Products, developed by CS Group 19 for Second Year Group Project at UCSC. There are currently 5 main stakeholders in this system.

• Producer (Farmer)
• Manufacturer (Value-adder)
• Customer
• Agri-Officer
• Admin

Project at a glance

• Web based system and marketplace to connect farmers, manufacturers/value-adders & end consumers/retailers to streamline the process of producing and selling agri and crop products

• Dynamic crop production suggestions based on land conditions and demand

• Minimises shortage & surplus and maximises gains for all

• Plus, a platform for agri officers to connect with farmers

High level process

Producers

✔️ Enter land & cultivation details
✔️ Get crop production suggestions & view crop analytics
✔️ Record harvests & view details
✔️ Connect with manufacturers
✔️ Ask questions regarding cultivations from agri officers
✔️ View & respond to crop requests from manufacturers
✔️ View agri-officer announcements

Manufacturers

✔️ View purchase & sales reports
✔️ Maintain e-commerce store & manage sales
✔️ Record purchases & manage stocks
✔️ Manage products & categories
✔️ Connect with producers
✔️ Post crop requests to producers
✔️ Respond to customer inquiries

Customers

✔️ Browse & search for agricultural products
✔️ Add to cart & checkout
✔️ Send inquiries about products to manufacturers
✔️ View list of manufacturers
✔️ Visit manufacturer stores
✔️ Manage orders

Agri-Officers

✔️ View crop analytics
✔️ Publish announcements to producers
✔️ View producers & lands in district
✔️ View cultivation & harvest details
✔️ Set crop prices for district
✔️ Respond to cultivation questions

System Admin

✔️ View reports & analytics
✔️ View all products
✔️ Hide irrelevant products
✔️ Manage data related to crops in the system
✔️ View producer details
✔️ View manufacturer details
✔️ View announcements
✔️ Manage users and add agri-officers to the system

🫱🏻‍🫲🏻 Group Details

Group 19 - Computer Science

Name	Reg No:
Sandul Renuja	2020/CS/054
Surani Sooriyaarachchi	2020/CS/181
Rumindu De Silva	2020/CS/034
Vinuri Ridmika	2020/CS/148

💻 Technologies

Architecture : MVC
Frontend : HTML SASS JS
Backend : PHP
Package Manager : Composer

Tech Stack: LAMP Stack

Web Server OS : Linux - Ubuntu
Web Server : Apache
Database : MySQL
Backend Programming Language : PHP

Built with

Libraries used

PHP

• PHP dotenv
• PHP Mailer

⚡ Getting Started

❕ Prerequisites

You need a computing environment with an up to date version of Windows/Mac OS/Linux and a working internet connection

• Git
• Bash (For setting up Git hooks)
• Apache
• PHP 5.6+
• MySQL
• Composer
• A web browser (Chrome/Edge recommended)

🔻 Downloading

• Clone the code repo using HTTPS, SSH or Github CLI or download the zip file

git clone https://github.com/UCSC-SYGP-G19/krushi-arunalu.git

🚀 Installing and executing (dev)

Install XAMPP for an easy quickstart. WAMP or MAMP can also be used instead.

1. Move the project folder to the htdocs folder in the XAMPP installation directory (or for Apache on Linux, move the project folder to /var/www/html/).
2. Create database by importing the latest sql dump file to your database server.
3. Create .env file using the .sample.env template and update the required details.
4. Run composer install in project root to install the required dependencies and setup git hooks (Make sure you have composer and GNU Bash or Git Bash installed).

.htaccess files

1. Modify RewriteBase of .htaccess file in the root folder to match the name of the project folder inside localhost

RewriteBase /<your root folder>/

2. Modify RewriteBase of .htaccess file in the /public folder to match the name of the project folder inside localhost

RewriteBase /<your root folder>/public

✅ Open the project in your browser using the URL:

http://localhost:port/your-root-folder

For example, if your root folder is krushi-arunalu and you are using port 80, the URL will be http://localhost/krushi-arunalu

📂 File Structure

.
├── app
│   ├── config
│   ├── controllers
│   ├──  core
│       ├── App.php
│       ├── Controller.php
│       ├── Database.php
│       ├── Model.php
│       └── View.php
│   ├── db
│   ├── helpers
│   ├── models
│   └── views
│
├── logs
├── public
│   ├── css
│   ├── favicons
│   ├── img
│   ├── js
│   ├── sass
│   ├── .htaccess
│   └── index.php  <- app entry point
│
├── scripts
├── .env
└── .htaccess

• Only the important files and directories are shown in the above tree

🔒 License

This project is licensed under the MIT License - see the LICENSE.md file for details