XShop Documentation

Everything Documented about the XShop project.

• Team members

• The Project's Proposal

• Tech Stack

• Software tools

• High Level Design

• Detailed Design

  • Web Pages
    • Home page
    • Point of Sale
    • Data Entry
    • Admin Dashboard
    • Login
  • API Endpoints
    • User Login
    • User Logout
  • DB Models
    • User
    • Customer
    • Cashier
    • DataEntryClerk
    • SubManager
    • Manager
    • Shop
    • PricingPlan
    • Product
    • OrderItem
    • Order
    • Invoice
  • Mobile Screens
    • Home page

• Research Notes

  • The Marketplace
  • Order Fulfillment
  • Pricing Plans
  • PWA offline
  • System Reports
  • Taxes
  • Traceability Matrix

How to contribute

• clone the repo / pull to get latest
• make sure you're on develop branch $ git checkout develop
• if you already have the repo, make sure you have latest updates $ git pull origin develop
• branch out $ git checkout -b new_branch_name
• write your text/code
• push to GitHub $ git push origin new_branch_name
  • if you push you'll find a link in the terminal, click on it to make a PR
• go to GitHub, the repo page, and make a PR (Google it if you don't know how.)