-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the central knowledge base for SkillSphere-CAT, a modern, institutional-grade platform for web-based assessments, course management, and personalized learning.
This Wiki serves as the primary source of documentation for developers, contributors, and administrators. Here you will find detailed information on architecture, setup, feature guides, and contribution standards.
This section is for anyone new to the project, whether you are a user, developer, or contributor.
- Project Overview: (You are here) A high-level introduction to the project's vision and goals.
- Core Features: A detailed, user-facing list of what SkillSphere-CAT can do, including course management, assessment tools, and AI features.
- Live Demo Guide: Information on accessing the public demo, what features are available, and any demo-specific credentials or limitations.
This section covers everything you need to get a local instance of the application running on your machine.
- Local Setup & Installation: A step-by-step guide to forking, cloning, installing dependencies, and running the Vite development server.
-
Environment Variables: A complete guide to setting up your
.env.localfile. This is required for connecting to Firebase and other services. - Firebase Configuration: How to set up your own Firebase project (Authentication, Firestore, Storage) to work with the application.
- ImageKit Configuration: (If applicable) How to set up an ImageKit account for media uploads and transformations.
Understand the "how" and "why" behind the project's design.
- Technology Stack: A detailed list of the core technologies (React, Vite, TS), major libraries (Framer Motion, Tailwind), and backend services (Firebase).
-
Folder Structure: A complete breakdown of the repository's directory structure (
src/pages,src/components,src/admin,src/hooks, etc.) and the purpose of each. -
Database Schema: A critical overview of the Firestore database structure. This details the collections (
users,courses,quizzes,userProgress) and the data models within them. - Authentication Flow: A diagram and explanation of how user login, registration, and role-based access control (Student, Admin, Super-Admin) are implemented.
-
State Management: Our philosophy on managing state, detailing what is handled by local component state (e.g.,
useState), shared context (React Context), or server-side fetching.
We welcome contributions! Please read these guides to get started.
- Contribution Guidelines (CONTRIBUTING.md): The main rules, Code of Conduct, and the Fork/Branch/PR workflow. (Please read this first!)
- Code Style Guide: Specifics on TypeScript usage, React Hook patterns, component naming conventions, and Tailwind CSS best practices.
- How to Submit a Bug Report: Best practices for creating an issue that helps us quickly identify and fix problems.
- How to Suggest a Feature: How to format feature requests to maximize their chance of being implemented.
Detailed documentation on specific, complex features of the platform.
- AI Integration: How the AI Course Creator and AI Quiz Creator features are implemented, including prompts and API-agnostic design.
- Course Management: A technical look at how courses, modules, and sub-modules are created, edited, and rendered.
-
Assessment Engine: How quizzes are created, stored, and how results are processed and saved to
userProgress. - Practice Modules: Documentation on the "Misc Features" like the Code Arena, DSA Solver, and Flashcard system.