garnet-aisa System Requirements Document

1. Introduction

This document outlines the system requirements for the "garnet-aisa" project, developed by Moxie Digital. The project aims to create an application with functionalities inspired by the provided visual reference.

2. System Overview

The garnet-aisa project is designed to provide users with a platform to complete tasks and earn rewards. The application will feature a user-friendly interface, allowing users to manage tasks, track earnings, and interact with various features seamlessly.

3. Functional Requirements

• As a User, I should be able to view and complete tasks to earn rewards.
• As a User, I should be able to track my earnings and transaction history.
• As a User, I should be able to share referral links to invite friends.
• As a User, I should be able to view and claim bonuses.
• As an Admin, I should be able to manage user accounts and settings.
• As an Admin, I should be able to view all transactions and task completions.

4. User Personas

• User: Individuals who use the app to complete tasks and earn rewards.
• Admin: Personnel responsible for managing the application and overseeing user activities.

5. Core User Flows

• User logs in -> views available tasks -> completes a task -> earns rewards -> checks wallet for updated balance.
• User shares referral link -> friend joins -> both earn referral bonuses.
• Admin logs in -> reviews user activities -> manages settings and user accounts.

6. Visuals Colors and Theme

• primary: #4A90E2 (blue)
• primary_light: #B3D4FC (light blue)
• secondary: #F5A623 (orange)
• accent: #7ED321 (green)
• highlight: #F8E71C (yellow)
• bg: #FFFFFF (white)
• surface: rgba(255, 255, 255, 0.9)
• text: #333333 (dark gray)
• text_muted: #888888 (gray)
• border: rgba(0, 0, 0, 0.1)

7. Signature Design Concept

The homepage will feature an interactive 3D carousel of task cards using @react-three/fiber. Users can rotate the carousel to explore different tasks. Each card will flip to reveal task details when clicked. The background will have a subtle animated gradient that shifts colors based on user interactions, creating an engaging and dynamic experience.

8. Interaction Model & Motion Direction

• Interaction Model: Parallax
• Motion Direction: The landing page will have layered depth with scroll-triggered animations. Task cards will animate into view with spring physics, and hover transitions will provide feedback on interactive elements.

9. Non-Functional Requirements

• The application must be responsive and perform well on both mobile and desktop devices.
• Ensure secure access control and data protection for all user information.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB
• AI Models: Not specified
• AI Tools: Not specified
• Local Orchestration: Docker, docker-compose
• Server Side Orchestration: Kubernetes

11. Assumptions and Constraints

• The application will primarily target users in India.
• The system should handle a large number of concurrent users efficiently.

12. Glossary

• Task: An activity that users can complete to earn rewards.
• Reward: Monetary or point-based compensation for completing tasks.
• Referral: A system where users can invite others to join and earn bonuses.