Sharekwik System Requirements Document

Introduction

Sharekwik is a comprehensive ecosystem designed to integrate various microsaas modules, each addressing specific business needs. The project aims to streamline processes such as contact management, gatepass facilitation, truck booking, document submission, task delegation, and material tracking. This document outlines the system requirements for Sharekwik, focusing on the integration of Leadskwik with OCR for business card scanning, NFC and BLE beacon contact sharing, and the development of interconnected microsaas modules.

System Overview

Sharekwik serves as the umbrella platform for multiple microsaas applications, providing a cohesive and modular solution for businesses. The system will enable seamless integration and interaction between the following modules:

• Leadskwik: Facilitates contact logging via various methods, including OCR for business card scanning and NFC/BLE for contact sharing.
• Passkwik: Streamlines gatepass requests for drivers and fleet managers.
• Savaq: Offers transparent pricing, urgent sourcing, delivery tracking, and more for industrial deliveries.
• Xpd8: Assists expeditors in tracking and following up on their work.
• Prequal Engine: Simplifies the preparation and tracking of prequalification documents.
• Submittal Engine: Manages the submission and tracking of technical documents.
• Delegatekwik: Enables task delegation and tracking for managers.
• Pipeline Passport: Tracks and documents site material installation history.

These modules are designed to work independently or as part of the Sharekwik ecosystem, allowing users to select and integrate modules as needed.

Functional Requirements

• As a User, I should be able to log contacts into a spreadsheet by uploading vcards, Excel sheets, or using NFC.
• As a User, I should be able to capture contacts by scanning business cards through OCR.
• As a User, I should be able to share my contact information using the Leadskwik card via WiFi and BLE beacons.
• As a Shop Owner, I should be able to send offers to passersby using WiFi and BLE beacons.
• As a Driver or Fleet Manager, I should be able to share my details easily with security and site teams using Passkwik.
• As a User, I should be able to book trucks, manage shipping, and track deliveries using Savaq.
• As an Expeditor, I should be able to track and follow up on my work using Xpd8.
• As a User, I should be able to prepare, submit, and track prequalification documents using the Prequal Engine.
• As a User, I should be able to prepare, submit, and track technical submittal documents using the Submittal Engine.
• As a Manager, I should be able to delegate tasks to colleagues and superiors using Delegatekwik.
• As a User, I should be able to track and document site material installation history using Pipeline Passport.

User Personas

• General User: Individuals using Sharekwik for contact management and document handling.
• Shop Owner: Business owners utilizing beacon technology for marketing.
• Driver/Fleet Manager: Users managing logistics and gatepass processes.
• Expeditor: Professionals tracking and managing project timelines.
• Manager: Individuals responsible for delegating tasks and overseeing operations.

Core User Flows

• User logs into Sharekwik -> Uploads contacts via vcard/Excel/NFC -> Scans business cards using OCR -> Contacts are updated in the spreadsheet.
• Shop Owner configures offers -> Uses WiFi/BLE beacons -> Offers are sent to passersby.
• Driver logs into Passkwik -> Shares details with security -> Gatepass is expedited.
• User accesses Savaq -> Books truck -> Manages shipping -> Tracks delivery.
• Expeditor logs into Xpd8 -> Tracks work -> Follows up on tasks.
• User accesses Prequal Engine -> Prepares documents -> Submits and tracks them.
• User accesses Submittal Engine -> Prepares technical documents -> Submits and tracks them.
• Manager logs into Delegatekwik -> Delegates tasks -> Tracks task progress.
• User accesses Pipeline Passport -> Tracks material installation -> Documents history.

Visuals Colors and Theme

• primary: #1E3A8A (Deep Blue)
• primary_light: #3B82F6 (Light Blue)
• secondary: #F59E0B (Amber)
• accent: #EF4444 (Red)
• highlight: #FBBF24 (Gold)
• bg: #F3F4F6 (Light Gray)
• surface: rgba(255, 255, 255, 0.8)
• text: #111827 (Dark Gray)
• text_muted: #6B7280 (Muted Gray)
• border: rgba(209, 213, 219, 0.2)

Signature Design Concept

The Sharekwik landing page will feature an interactive "Network Hub" concept. Users will see a dynamic, animated network of nodes representing different microsaas modules. As users hover over each node, it expands to reveal more information and connections to other modules. The nodes will animate in a fluid motion, simulating a living ecosystem. This concept will be implemented using motion/react for smooth animations and interactions.

Landing Hero Motion Brief

The landing hero will depict a "Digital Ecosystem" where inputs (business cards, documents, etc.) flow into a central hub (Sharekwik), transforming into organized outputs (contacts, approvals, etc.). The animation will loop every 10 seconds, showing the transformation process. Users can interact by clicking on different elements to learn more about each module. The animation will be responsive and accessible, with a reduced-motion option for users who prefer it.

Interaction Model & Motion Direction

• Interaction Model: Animated
• The landing page will feature moderate scroll-triggered reveals and hover transitions. Interactive elements will have spring physics for a polished user experience.

Non-Functional Requirements

• The system must support high-volume data processing for OCR and beacon interactions.
• Ensure secure data handling and privacy compliance.
• The platform should be scalable to accommodate additional microsaas modules in the future.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB
• AI Models: GPT 5.4 for user-friendly responses
• AI Tools: Litellm for LLM Routing
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

Assumptions and Constraints

• The system assumes users have access to NFC and BLE-enabled devices.
• The platform will be hosted on a cloud infrastructure to ensure scalability and availability.
• Integration with third-party services for OCR and beacon technology is required.

Glossary

• OCR: Optical Character Recognition
• NFC: Near Field Communication
• BLE: Bluetooth Low Energy
• Microsaas: A small, focused software-as-a-service application
• Gatepass: A pass that allows entry and exit from a site
• Expeditor: A person responsible for ensuring the timely delivery of goods or services