IsraelChidera / WVMS_API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Water Vendor Management System

logo

Table of Contents

Project Description

A niche based software solution design for SMEs, that allows bottled water vendors to manage inventory, sales, and customer records efficiently. Providing data for measuring business growth and determining attributes that contribute to profitability.

Problem Statement

Most SMEs deal with issues of inventory, sales and customer management. Over 85% of bottle water vendors do not keep customer records or keep a list of leads for subsequent reach out. Hence, losing out on conversions and maintainng customer loyalty.
The failure to track sales and generate metrics for business growth mean, these business are always limited to a certain scope.
These businesses are localized and operate only within the environ limiting quick access to services and product delivery. A software solution is can be a bridge between the vendors and customers, providing a contactless transaction environment, and affording vendors tracking metrics and management resources out of the box.

Technology Stack

  • IDE

Visual studio

  • Project Management
    Trello

  • Language
    CSharp .Net

  • Web Framework

asp.net core

  • Hosting
    AWS

  • Version Control
    GitHub

  • Database
    MicrosoftSQLServer

Contributors Guide

  1. Visit the project repository on Github

  2. Make a local clone:
    Create a folder on your local machine for the project
    Open Command prompt / Terminal in the same folder location
    In your Terminal, type:
    git clone https://github.com/Tenece-BEZAO/WVMS_API.git

  3. Pull upstream to get up to date with the original repo:
    git pull -u development

  4. Create a new branch for the task you are working on :
    git checkout -b branchName
    (Ensure your branchName is descriptive in context to the feature you are working on. Also be sure to check which branch you are on using git status before you begin working)

  5. When you're done with your task, run:
    git add

  6. Commit changes with descriptive message:
    git commit -m "message"

  7. To avoid conflicts:
    git pull -u development *(before branching out to a new branch)

  8. Then push your branch:
    git push origin branchName - This creates the branch remotely and pushes to that branch on the Github

  9. Go to Github and create a new pull request to the development branch, for review and subsequent merge.

Features of the Application

Unauthenticated Users - An individual that has not registered on website would be able to:

  • Visit the platform to view listed products by vendors
  • Register as either a customer or a vendor to access more functionalities
  • No access to use until registered

Authenticated Users - A user can be only one of; vendor or customer:

  • Full access to the platform
  • Allow profile creation and edit
  • Access to transaction history
  • Allow vendors to list product and customers to place orders
  • Allow vendors access to key metrics to track business growth

Admin User

  • User management and access control
  • Delist fraudulent vendors
  • Backup and restore functionalities
  • Monitor system performance and health

Product Specialization

  • Mobile Phones
  • Tablets
  • Laptops

Project Status

Status : in progress

Contributors

👤 Joshua Eze (Team Lead)

👤 Chuka Ogbodo

👤 Israel Chidera

Deployment Instruction

Relevant Links

Acknowledgements

License

About


Languages

Language:C# 100.0%