coral-3 System Requirements Document

1. Introduction

The coral-3 project aims to develop a micro SaaS solution for tour and gig management, specifically targeting independent musicians. This system will facilitate the management of availability, booking requests, contract generation, payment tracking, and tour logistics. The solution is designed to cater to niche segments such as regional indie bands, wedding/function musicians, and DJ touring.

2. System Overview

The coral-3 system will provide a comprehensive platform for independent musicians to manage their tours and gigs efficiently. By integrating with popular services like Stripe, PayPal, and Google Calendar, the system will streamline the booking and payment processes. Additionally, it will offer features such as auto-generated contracts and logistics management to enhance the user experience.

3. Functional Requirements as Story Points

• As an independent musician, I should be able to publish my availability to potential clients.
• As a client, I should be able to send booking requests to musicians.
• As an independent musician, I should be able to accept or decline booking requests.
• As an independent musician, I should be able to auto-generate contracts for confirmed bookings.
• As an independent musician, I should be able to track deposits and payments through Stripe or PayPal.
• As an independent musician, I should be able to manage tour logistics, including routes, venues, and expenses.
• As an admin, I should be able to charge per artist/band with options for multi-member teams or agency white-labeling.
• As an independent musician, I should be able to integrate my schedule with Google Calendar.

4. User Personas

• Independent Musician: A solo artist or band member looking to manage their tour schedules and bookings efficiently.
• Client: An individual or organization looking to book musicians for events.
• Admin: The system administrator responsible for managing user accounts and billing.

5. Core User Flows

• Independent musician publishes availability -> Client sends booking request -> Musician accepts/declines request -> Contract is auto-generated -> Payment is tracked -> Tour logistics are managed.
• Admin sets up pricing model -> Manages billing per artist/band -> Offers add-ons for multi-member teams or agency white-labeling.

6. Visuals Colors and Theme

• primary: #1E90FF (Dodger Blue)
• primary_light: #63B8FF (Light Sky Blue)
• secondary: #FFD700 (Gold)
• accent: #FF4500 (Orange Red)
• highlight: #32CD32 (Lime Green)
• bg: #F0F8FF (Alice Blue)
• surface: #FFFFFF (White)
• text: #000000 (Black)
• text_muted: #696969 (Dim Gray)
• border: #D3D3D3 (Light Gray)

7. Signature Design Concept

Interactive Tour Map

The homepage will feature an interactive tour map where users can visualize their tour routes. Each venue will be marked on the map, and clicking on a venue will display details such as booking status, contracts, and payments. The map will be dynamic, allowing users to drag and zoom to explore different regions. The map will be built using @react-three/fiber for 3D interactions, providing an engaging and immersive experience.

LANDING HERO MOTION BRIEF

The landing page will feature a dynamic illustration of a musician's journey. Instruments and music notes will gather around a central tour bus, which transforms as it travels across a map, highlighting different venues. This 10-second loop will use motion/react for smooth transitions and interactions, offering a captivating introduction to the platform's capabilities.

8. Interaction Model & Motion Direction

• Intended Interaction Model: Parallax
  • The landing page will utilize a parallax effect to create depth, with layers of musical elements moving at different speeds as the user scrolls. This will enhance the storytelling aspect of the musician's journey.
• Internal Pages: Static
  • Internal pages such as dashboards and settings will focus on clarity and minimal motion to ensure ease of use.

9. Non-Functional Requirements

• The system must ensure data security and privacy for all users.
• The platform should be scalable to accommodate a growing number of users and bookings.
• The system should maintain high availability and performance, especially during peak booking times.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, with alembic for migrations
• Payment Integration: Stripe, PayPal
• Calendar Integration: Google Calendar
• Containerization: Docker, docker-compose
• Orchestration: Kubernetes

11. Assumptions and Constraints

• The system will primarily target independent musicians in regions with high demand for live performances.
• Pricing will be competitive, ranging from $19 to $49 per month.
• The system will need to handle multiple currencies and payment methods.

12. Glossary

• Independent Musician: A solo artist or band not signed to a major record label.
• Booking Request: An inquiry from a client to hire a musician for an event.
• Contract: A legal agreement between the musician and the client outlining the terms of the booking.
• Tour Logistics: The planning and management of travel, accommodations, and other aspects of a musician's tour.