System Requirements Document (SRD)

Project Name: teal-dj

1. Introduction

The teal-dj project is a cutting-edge application designed to help DJs, like Mista P, organize and create dynamic DJ sets. The app focuses on enabling users to upload their own music files and arrange them based on key, music style, and energy progression. This tool is tailored to enhance the DJing experience by providing intuitive features for seamless music curation and set creation.

This document outlines the system requirements for teal-dj, ensuring the project meets the needs of its users while adhering to best practices in software development.

2. System Overview

teal-dj is a web and mobile application that allows users to:

• Upload their own music files.
• Organize tracks based on key, music style, and energy progression.
• Create and save DJ sets for live performances or personal use.
• Provide a visually engaging and user-friendly interface tailored for DJs.

The system will support both desktop and mobile platforms, ensuring accessibility and usability for DJs on the go. It will leverage modern technologies to deliver a seamless experience, including advanced sorting algorithms and an intuitive drag-and-drop interface for set creation.

Locale-specific defaults will be applied for Mista P, such as UK time zones (GMT/BST) and currency (GBP) if any monetization features are added in the future.

3. Functional Requirements

• As a User, I should be able to upload my own music files.
• As a User, I should be able to organize tracks based on key, music style, and energy progression.
• As a User, I should be able to create and save DJ sets.
• As a User, I should be able to visually see the energy progression of my DJ set.
• As a User, I should be able to drag and drop tracks to arrange my set.
• As a User, I should be able to preview tracks within the app.

4. User Personas

1. DJ User:

   • Primary user of the application.
   • Needs to upload, organize, and create DJ sets.
   • Requires an intuitive interface for quick and efficient set creation.

2. Guest User:

   • Can explore the app in a limited capacity (e.g., view sample sets or demo features).
   • Cannot upload or save sets without creating an account.

3. Admin:

   • Manages user accounts and monitors system performance.
   • Handles content moderation and resolves user issues.

5. Visuals Colors and Theme

The teal-dj app will adopt a vibrant, modern aesthetic inspired by the energy of music and nightlife. The proposed color palette includes:

• Teal (#008080): Primary color for branding and key UI elements.
• Black (#000000): Background color for a sleek, professional look.
• White (#FFFFFF): Text and contrast elements for readability.
• Electric Blue (#00FFFF): Accent color for interactive elements.
• Neon Pink (#FF1493): Secondary accent for highlights and energy indicators.

The theme will evoke the feel of a nightclub or music festival, with glowing neon accents and dynamic transitions.

6. Signature Design Concept

Interactive Soundwave Landing Page

The homepage of teal-dj will feature an interactive soundwave visualization that reacts to user input. Here's how it works:

• A dynamic soundwave animation will span the width of the screen, pulsating in sync with a background track.
• Users can interact with the soundwave by hovering over it, causing sections to ripple and display track details (e.g., title, key, energy level).
• A drag-and-drop demo will be embedded directly on the homepage, allowing users to experiment with arranging tracks in real-time.
• As users scroll, the soundwave will morph into a timeline view, showcasing the app's features in a visually engaging way.
• Neon accents will glow and shift colors subtly, creating a vibrant, immersive experience.

This bold and unforgettable design will immediately captivate users and set the tone for the app's innovative features.

7. Non-Functional Requirements

• The system must support file uploads up to 100MB per track.
• The app must load within 3 seconds on a standard broadband connection.
• The interface must be responsive and optimized for both desktop and mobile devices.
• The system must ensure data security and comply with GDPR regulations.
• The app must handle up to 10,000 concurrent users without performance degradation.

8. Tech Stack

Frontend:

• React for web application.
• React Native for mobile application.

Backend:

• Python with FastAPI for API development.

Database:

• MySQL for relational data storage.
• Alembic for database migrations.

AI Models:

• GPT 5.2 for user-friendly responses and recommendations.

AI Tools:

• Langchain for advanced AI workflows.

Orchestration:

• Docker and docker-compose for local development.
• Kubernetes for server-side orchestration.

9. Assumptions and Constraints

• Users will provide their own music files for upload.
• The app will initially target English-speaking users in the UK.
• The system will not include a built-in music library due to licensing constraints.
• The app will require an internet connection to function.

10. Glossary

• Key: The musical key of a track, used to determine compatibility with other tracks.
• Energy Progression: The perceived intensity or energy level of a track, used to create dynamic DJ sets.
• Drag-and-Drop: A user interface feature allowing users to click and move elements to rearrange them.
• Soundwave Visualization: A graphical representation of audio, often used to display track waveforms.
• GDPR: General Data Protection Regulation, a legal framework for data protection and privacy in the European Union.

This document outlines the vision and requirements for teal-dj, ensuring it meets the needs of DJs like Mista P while delivering a unique and engaging user experience.