System Requirements Document for man-poultry

1. Introduction

The "man-poultry" project aims to develop a web application for a poultry farm. The primary intent is to enable customers to place orders online, which are then automatically sent to the farm admin's WhatsApp for processing. This system is designed to streamline the order process and ensure efficient communication between customers and the farm.

2. System Overview

The web application will serve as a digital marketplace for the poultry farm, allowing customers to browse offerings and place orders. Upon order submission, the system will automatically notify the farm admin via WhatsApp. The application will feature a user-friendly interface inspired by bold Americana design, ensuring a memorable and approachable experience for users.

2a. Product Interpretation and Delivery Boundary

The application is a web-based platform specifically for the poultry farm, with a focus on direct-to-consumer sales. It includes custom UI elements and integrates with WhatsApp for order notifications. The system is designed for current delivery, with no future expansions or adjacent capabilities implied. The application will not include account management or differentiated permissions, as all interactions are public and anonymous.

2b. Source Content Inventory

Not applicable as no content source directive was provided.

2c. Page Content and Component Coverage

Landing

• Purpose: Introduce the poultry farm and direct customers to offerings.
• Components:
  • Introduction to the farm and its offerings.
  • Navigation to the Orders page.
  • Visual elements: Halftone photo of the farm, badge-style headlines.

Orders

• Purpose: Allow customers to browse and select poultry offerings.
• Components:
  • List of available products with descriptions and prices.
  • Option to select and add products to an order.
  • Navigation to Order Details for checkout.

Order Details

• Purpose: Collect necessary information for order fulfillment.
• Components:
  • Form for customer details (name, contact information).
  • Order summary and confirmation option.
  • Submit button to finalize the order and trigger WhatsApp notification.

3. Functional Requirements

• As a Customer, I should be able to browse poultry offerings on the web app.

  • Provenance: explicit
  • Lifecycle: Initiation on the Landing page, selection on the Orders page, continuation to Order Details.

• As a Customer, I should be able to place an order through the web app.

  • Provenance: explicit
  • Lifecycle: Selection on the Orders page, submission on the Order Details page, automatic notification to admin.

• As a Farm Admin, I should receive customer orders automatically via WhatsApp.

  • Provenance: explicit
  • Lifecycle: Triggered by customer order submission, received on WhatsApp.

4. User Personas

• Customer: Uses the web app to place orders for poultry products. Interacts with the Landing, Orders, and Order Details pages.
• Farm Admin: Receives order notifications via WhatsApp. Does not interact directly with the web app.

5. Core User Flows

Customer Flow

1. Access Landing Page: Customer visits the web app and views the introduction to the farm.
2. Navigate to Orders: Customer selects the Orders page to view available products.
3. Select Products: Customer browses offerings and selects desired products.
4. Proceed to Order Details: Customer moves to the Order Details page to provide necessary information.
5. Submit Order: Customer completes the form and submits the order.
6. Order Notification: System sends the order details to the Farm Admin's WhatsApp.

Farm Admin Flow

1. Receive Order Notification: Automatically receives order details via WhatsApp upon customer submission.

6. Visuals Colors and Theme

• Muse: Aaron Draplin
• Palette:
  • Background: #FBF7EF
  • Surface: #FFFFFF
  • Text: #333333
  • Primary: #FF7F11
  • Accent: #007B55
  • Muted: #D1C4A8
• Typography:
  • Headings: Alfa Slab One, bold, uppercase
  • Body: Oswald
• Shape Language: Sturdy, badge-like shapes with thick strokes.
• Imagery: Halftone photos and thick-line vector icons.

7. Signature Design Concept

The public entry page will feature a full-bleed hero image of the farm in halftone style, overlaid with a large badge-style headline in Alfa Slab One. A prominent call-to-action button in primary orange will guide users to explore the farm's offerings.

8. Interaction Model & Motion Direction

• Interaction Model: Static
• Motion Tempo: Restrained
• Hero Dimensionality: Flat
• Landing Hero Motion Brief: A static hero image with a bold badge-style headline and primary orange call-to-action button. Minimal animations focus on functional feedback.

9. Non-Functional Requirements

• Performance: The web app should load quickly and handle multiple simultaneous users without degradation.
• Reliability: Order notifications must be sent reliably to WhatsApp without failure.
• Usability: The interface should be intuitive and easy to navigate for all users.

10. Tech Stack

• Frontend: React
• Backend: Python/FastAPI
• WhatsApp Integration: WhatsApp Business API
• Deployment: Docker, Kubernetes (if required for scaling)

11. Assumptions and Constraints

• Assumption: All customer interactions are public and do not require authentication.
• Constraint: The system must integrate with WhatsApp to send order notifications automatically.

12. Glossary

• Web App: An application accessed via a web browser.
• WhatsApp: A messaging platform used for sending order notifications.
• Order Notification: A message sent to the Farm Admin containing details of a customer order.