System Requirements Document for ajistar-laundry

1. Introduction

Ajistar Laundry is a web application designed to streamline the operations of a laundry business. The application is intended for use by administrators, customers, and receptionists, providing a comprehensive platform for managing laundry services, subscriptions, payments, and customer interactions. The application will be developed using HTML, CSS, JavaScript, PHP, and MySQL, with a focus on ease of use, modern design, and robust security.

2. System Overview

Ajistar Laundry is a CMS-style web application that allows administrators to configure and manage various aspects of the laundry business. Customers can subscribe to services, make payments online, and track their orders. The application supports online payments via Paystack or Flutterwave and includes features such as subscription plans, referral programs, notifications, and a receptionist interface for walk-in customers. The design is warm and approachable, inspired by Pablo Stanley, with a focus on accessibility and user engagement.

2a. Product Interpretation and Delivery Boundary

The application is delivered as a CMS-based web app with backend configuration capabilities for administrators. It supports customer self-service enrollment and verification, with role-based access for admins and receptionists. The application ensures secure server-side session management and integrates with external payment and notification providers. The design emphasizes a modern, graphic-rich interface with customizable elements.

2b. Source Content Inventory

Not applicable as no content source directive was provided.

2c. Page Content and Component Coverage

Landing

• Information/State: Overview of Ajistar Laundry, services offered, and value proposition.
• Primary Actions: Navigate to login or service subscription.
• Components: Hero illustration, service highlights, call-to-action buttons.
• States: Loading, success, error.

Login

• Information/State: User authentication for customers, admins, and receptionists.
• Primary Actions: Login, password recovery.
• Components: Login form, error messages.
• States: Loading, success, error.

Dashboard

• Information/State: Summary of user-specific operations and navigation to work areas.
• Primary Actions: Access services, orders, referrals, and settings.
• Components: Navigation menu, user-specific widgets.
• States: Loading, success, error.

Services

• Information/State: Catalog of available laundry services.
• Primary Actions: Subscribe to services.
• Components: Service listings, subscription buttons.
• States: Loading, empty, success, error.

Plans

• Information/State: Admin management of subscription plans.
• Primary Actions: Create, edit, delete plans.
• Components: Plan form, list of plans.
• States: Loading, success, error.

Promotions

• Information/State: Admin management of discounts, promotions, and coupons.
• Primary Actions: Create, edit, delete promotions.
• Components: Promotion form, list of promotions.
• States: Loading, success, error.

Orders

• Information/State: Tracking of customer orders and operational progress.
• Primary Actions: View order details, track readiness.
• Components: Order list, tracking details.
• States: Loading, success, error.

Referrals

• Information/State: Customer referral balance and conversion options.
• Primary Actions: Convert points to credits.
• Components: Referral balance, conversion form.
• States: Loading, success, error.

Operations

• Information/State: Admin tracking of purchases, costs, profits, and consumables.
• Primary Actions: View operational metrics.
• Components: Metrics dashboard, consumable inventory.
• States: Loading, success, error.

Customers

• Information/State: Admin review of customer data for marketing and surveys.
• Primary Actions: Filter and view customer data.
• Components: Customer list, filter options.
• States: Loading, success, error.

Walk-ins

• Information/State: Receptionist entry of walk-in customer services.
• Primary Actions: Register and render services.
• Components: Service entry form.
• States: Loading, success, error.

Notifications

• Information/State: Admin configuration of notification templates and shortcodes.
• Primary Actions: Create, edit, delete templates.
• Components: Template editor, shortcode list.
• States: Loading, success, error.

Settings

• Information/State: Admin configuration of CMS settings and landing page content.
• Primary Actions: Modify settings, update landing page.
• Components: Settings form, content editor.
• States: Loading, success, error.

3. Functional Requirements

• As an Admin, I should be able to configure the CMS backend to manage the laundry business operations. (explicit)
• As a Customer, I should be able to subscribe to laundry services and make payments online using Paystack or Flutterwave. (explicit)
• As a Customer, I should be able to log in to view my laundry orders, track readiness, and receive notifications. (explicit)
• As an Admin, I should be able to create and manage subscription plans, discounts, promotions, and coupons. (explicit)
• As a Customer, I should be able to participate in a referral program to earn points convertible to credits. (explicit)
• As an Admin, I should be able to track orders, purchases, costs, profits, and consumables. (explicit)
• As an Admin, I should be able to filter and review customer data for marketing and surveys. (explicit)
• As a Receptionist, I should be able to register and render walk-in customer services. (explicit)
• As an Admin, I should be able to generate receipt and tag numbers for successful payments. (explicit)
• As an Admin, I should be able to configure notification templates and shortcodes. (explicit)
• As a Customer, I should be able to receive email, SMS, and in-app notifications for subscriptions and payments. (explicit)

4. User Personas

• Admin: Configures and operates the CMS, manages plans, promotions, customers, orders, finances, inventory, referrals, notifications, and messages.
• Customer: Subscribes to services, pays online, monitors orders, uses referral credits, and receives notifications.
• Receptionist: Records walk-in laundry services registered and rendered.

5. Core User Flows

Admin Flow

1. Login: Admin logs into the system.
2. Dashboard Access: Admin accesses the dashboard to view operational summaries.
3. Manage Plans: Admin navigates to the Plans page to create or edit subscription plans.
4. Track Operations: Admin accesses the Operations page to monitor purchases, costs, and profits.
5. Customer Review: Admin filters and reviews customer data on the Customers page.
6. Configure Notifications: Admin sets up notification templates and shortcodes on the Notifications page.
7. Logout: Admin logs out of the system.

Customer Flow

1. Landing Page: Customer visits the landing page to learn about services.
2. Service Subscription: Customer navigates to the Services page to subscribe to a service.
3. Payment: Customer completes payment using Paystack or Flutterwave.
4. Order Tracking: Customer logs in to track order status on the Orders page.
5. Referral Program: Customer checks referral balance and converts points on the Referrals page.
6. Receive Notifications: Customer receives notifications via email, SMS, and in-app.
7. Logout: Customer logs out of the system.

Receptionist Flow

1. Login: Receptionist logs into the system.
2. Walk-in Registration: Receptionist navigates to the Walk-ins page to register services.
3. Service Entry: Receptionist enters details of services rendered.
4. Logout: Receptionist logs out of the system.

6. Visuals Colors and Theme

• Muse: Pablo Stanley
• Palette:
  • Background: #FFF8E1
  • Surface: #FFFFFF
  • Text: #333333
  • Primary: #FF5722
  • Accent: #FFC107
  • Muted: #E0E0E0
• Typography:
  • Headings: Nunito — Bold, large size, generous tracking, sentence case
  • Body: DM Sans
  • Scale: 1.25 modular, 48/36/24/18/16
• Shape Language: Rounded shapes with large radii, pill buttons, and blob-like elements.
• Layout: Open layout with generous padding, centered elements, and a modular grid.
• Imagery: Modular vector illustrations, hand-drawn accents, vibrant colors.

7. Signature Design Concept

The landing page features a large, friendly vector illustration of a person doing laundry, with playful text and a bright primary button. The design uses a cream background with vibrant primary and accent colors for visual interest. Rounded pill buttons and generous whitespace create a welcoming and engaging interface.

8. Interaction Model & Motion Direction

• Interaction Model: Animated
• Motion Tempo: Expressive
• Hero Dimensionality: Layered_2d
• Landing Hero Motion Brief: The hero area features a large illustration of a person interacting with laundry services. On hover, illustrations animate slightly, adding interactivity. The primary button has a springy hover effect, and the layout uses generous whitespace and a modular card layout.

9. Non-Functional Requirements

• Security: Implement comprehensive security measures to protect user data and transactions.
• Performance: Ensure fast load times and responsive interactions.
• Scalability: Design the application to handle increasing numbers of users and transactions.
• Usability: Provide an intuitive and accessible user interface.

10. Tech Stack

• Frontend: HTML, CSS, JavaScript
• Backend: PHP, MySQL
• Payment Integration: Paystack API, Flutterwave
• Notification Services: Email, SMS, in-app notifications

11. Assumptions and Constraints

• The application is specifically designed for Ajistar Laundry.
• The CMS-based architecture is a hard constraint.
• The implementation must use the specified technologies.
• Online payments must support Paystack or Flutterwave.
• Security vulnerabilities must be comprehensively addressed.

12. Glossary

• CMS: Content Management System
• Paystack: A payment processing service
• Flutterwave: A payment processing service
• AJL-12344: Receipt number format
• AJL-12344-001: Tag number format for laundry items