cosmic-english

byV. Teja

English learning app for free

HomeDashboardLoginVocabularyRegister
Home

Comments (0)

No comments yet. Be the first!

System Requirements

System Requirement Document
Page 1 of 7

System Requirements Document (SRD)

Project Name: cosmic-english

1. Introduction

Welcome to the System Requirements Document (SRD) for cosmic-english, an innovative English learning application designed to cater to learners of all levels — from beginners to advanced users. The project aims to provide free, accessible, and engaging tools for mastering English, empowering users across India and beyond.

This document outlines the system requirements for cosmic-english, ensuring clarity and alignment with the project's goals. It incorporates user feedback and updates, including the recent request to enable the pre-resolved API supervisor setting across all levels.

Page 2 of 7

2. System Overview

cosmic-english is a comprehensive platform for English language learning, offering features such as vocabulary building, quizzes, speaking practice, and more. The system is designed to support users at various proficiency levels, ensuring personalized learning experiences.

Key highlights of the system:

  • Free access for all users.
  • Adaptive learning paths tailored to individual progress.
  • Integration of advanced AI models for interactive and engaging content delivery.
  • Support for multiple user personas, including learners, administrators, and guests.
  • Locale-specific customization for Indian users, including timezone (IST) and cultural relevance.

The recent update introduces the pre-resolved API supervisor setting, enhancing the system's backend efficiency and ensuring seamless functionality across all levels.

3. Functional Requirements

As User:

  • I should be able to access free English learning resources for all levels.
  • I should be able to take quizzes to test my knowledge.
  • I should be able to practice speaking through interactive exercises.
  • I should be able to build my vocabulary using curated word lists.
  • I should be able to track my progress over time.
Page 3 of 7

As Admin:

  • I should be able to manage user accounts and permissions.
  • I should be able to monitor system performance and resolve issues.
  • I should be able to enable the pre-resolved API supervisor setting on all levels.

As Guest:

  • I should be able to explore limited resources without creating an account.
  • I should be able to view app features and benefits.

4. User Personas

1. Learner

  • Description: Primary user of the app, seeking to improve English skills.
  • Goals: Learn English at their own pace, track progress, and achieve fluency.
  • Features Access: Full access to quizzes, vocabulary tools, speaking practice, and progress tracking.

2. Administrator

  • Description: Oversees app operations and user management.
  • Goals: Ensure smooth functioning of the app, manage user accounts, and optimize system performance.
  • Features Access: Full access to backend settings, including API supervisor configurations.

3. Guest

  • Description: Casual visitor exploring the app without registration.
  • Goals: Discover app features and decide whether to sign up.
  • Features Access: Limited access to resources and app previews.
Page 4 of 7

5. Visuals Colors and Theme

The cosmic-english app will feature a vibrant and engaging color palette inspired by the cosmos, symbolizing exploration and growth.

Color Palette:

  • Background: #1E1F33 (Deep Space Blue)
  • Surface: #2A2D4F (Cosmic Gray)
  • Text: #F5F5F5 (Starlight White)
  • Accent: #FF6F61 (Nebula Coral)
  • Muted Tones: #A6A8B8 (Meteor Dust Gray)

This palette creates a visually appealing and immersive experience, reflecting the app's theme of discovery and learning.

6. Signature Design Concept

Page 5 of 7

Cosmic Galaxy Homepage

The homepage of cosmic-english will feature an interactive galaxy map. Users will navigate through a starry sky, where each star represents a feature or section of the app.

Details:

  • Animation: Stars twinkle subtly, and constellations form dynamically as users hover over them.
  • Interaction: Clicking on a star zooms into a specific feature (e.g., quizzes, vocabulary tools).
  • Transitions: Smooth zoom-in and zoom-out effects with a cosmic sound effect.
  • Color Shifts: The galaxy background subtly changes hues based on the time of day (e.g., warm tones during the day, cool tones at night).
  • Micro-interactions: Stars pulsate when hovered over, and tooltips display feature descriptions.

This design creates an unforgettable first impression, immersing users in the theme of exploration and learning.

7. Non-Functional Requirements

  • Performance: The app must load within 2 seconds for all users, regardless of device or network conditions.
  • Scalability: Support up to 1 million users concurrently.
  • Security: Implement robust encryption for user data and secure API endpoints.
  • Accessibility: Ensure compliance with WCAG 2.1 standards for accessibility.
  • Localization: Support Indian English conventions and integrate regional languages for translations.

8. Tech Stack

Frontend:

  • React for Web
  • React Native for Mobile App
Page 6 of 7

Backend:

  • Python
  • FastAPI

Database:

  • MySQL (with Alembic for migrations)

AI Models:

  • GPT 5.4 for user-friendly responses
  • Claude 4.6 Opas for academic or coding work
  • Gemini 3.1 Pro for friendly responses
  • Google Nano Banana for image generation

AI Tools:

  • Litellm for LLM Routing
  • Langchain

Local Orchestration:

  • Docker
  • docker-compose

Server-Side Orchestration:

  • Kubernetes
Page 7 of 7

9. Assumptions and Constraints

Assumptions:

  • Users will primarily access the app via mobile devices.
  • The app will cater to Indian users but remain accessible globally.
  • The pre-resolved API supervisor setting will enhance backend efficiency without affecting frontend performance.

Constraints:

  • Limited budget for initial development and deployment.
  • Dependency on third-party AI models and tools for advanced features.
  • Compliance with data protection regulations in India (e.g., GDPR equivalent).

10. Glossary

  • API Supervisor Setting: A backend configuration that optimizes API call handling for improved performance.
  • WCAG: Web Content Accessibility Guidelines, ensuring accessibility for users with disabilities.
  • LLM: Large Language Model, used for generating human-like text responses.
  • Docker: A platform for containerizing applications to ensure consistency across environments.
  • Kubernetes: A system for automating deployment, scaling, and management of containerized applications.
Home design preview
Login: Admin Sign In
Dashboard: View Overview
Users: Manage Accounts
Users: Edit Permissions
Settings: Configure API
Settings: Enable Supervisor
Reports: Monitor Performance