https://github.com/karimshaban01/shule-smart

https://github.com/karimshaban01/shule-smart

css html javascript nodejs oauth2 postgresql reactjs video whatsapp

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/karimshaban01/shule-smart
• Owner: karimshaban01
• Created: 2025-05-08T08:29:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-08T09:23:16.000Z (about 1 year ago)
• Last Synced: 2025-05-12T01:54:57.619Z (about 1 year ago)
• Topics: css, html, javascript, nodejs, oauth2, postgresql, reactjs, video, whatsapp
• Language: JavaScript
• Homepage:
• Size: 37.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Project Plan: NECTA-Based E-Learning Platform

1. Project Overview

Name: ShuleSmart (suggested Swahili-localized name)

Goal: To provide NECTA-aligned learning resources, practice tests, and interactive support for secondary school students in Tanzania.

Target Users: O-Level and A-Level students, teachers, and schools.

Distribution Channels: Web app, mobile app, WhatsApp groups.

2. Key Features

    NECTA-Curriculum-Aligned Content: Syllabus topics in text, PDF, and video formats.

    Interactive Tests & Quizzes: Auto-graded NECTA-style questions.

    Progress Tracking: Performance dashboard per subject and topic.

    Leaderboard & Gamification: Points for correct answers, badges, rankings.

    Rewards System: Redeem points for airtime or digital prizes.

    WhatsApp Support Groups: Subject-based groups with teacher moderation.

    Offline Access: Downloadable lessons or tests for students with limited data.

3. Timeline

Phase	Description	Duration

Requirements Gathering	Collaborate with NECTA teachers, gather syllabus	1 week

UI/UX Design	Design learner-friendly and mobile-first interfaces	1 week

Content Development	Record videos, write notes/tests (ongoing)	3 weeks+

Backend & Frontend Dev	APIs, dashboard, test engine, leaderboard	3 weeks

WhatsApp Integration	Setup groups, automation (via Twilio/360dialog)	1 week

Testing	Internal QA + pilot with 1-2 schools	1 week

Launch	National launch + school outreach	Ongoing

4. Tools & Technologies

    Frontend: React / Flutter (for mobile)

    Backend: Django / Node.js

    Database: PostgreSQL (student progress, content)

    Authentication: Firebase / Auth0 (with Google and SMS login)

    Video Hosting: YouTube (unlisted), Vimeo, or self-hosted

    Chat & Community: WhatsApp API, Discord (optional)

    Rewards API: Airtime APIs (e.g., Africa's Talking)

📄 Software Requirements Specification (SRS)

1. Introduction

1.1 Purpose

To develop a platform that enables students to learn NECTA-aligned material interactively, track their progress, and stay motivated through gamified learning and peer support.

1.2 Scope

The system includes:

    Content delivery per subject and topic.

    Practice questions with explanations.

    Leaderboards, points, and rewards.

    Integration with WhatsApp support groups.

    Teacher/mentor accounts for moderation.

2. System Features

2.1 NECTA Curriculum Navigation

    View topics by subject and class level.

    Toggle between notes, videos, and interactive tutorials.

2.2 Quizzes & Practice Tests

    Multiple choice, fill-in-the-blank, and timed exams.

    Students get instant results and explanations.

2.3 User Dashboard

    Progress by topic and subject.

    Weekly study time and test performance charts.

2.4 Leaderboard & Rewards

    Earn points from quizzes and login streaks.

    Leaderboard by school, region, and national level.

    Reward redemption system (airtime, e-certificates, badges).

2.5 WhatsApp Integration

    Auto-invite users to subject-specific groups.

    Scheduled reminders and mini-quizzes via bot.

    Teacher-moderated discussions.

2.6 Admin Panel

    Upload/edit learning content and questions.

    Manage users, teachers, leaderboard scores, and rewards.

    View platform analytics and engagement.

3. Non-Functional Requirements

    Availability: 24/7 access, with downtime limited to <1% monthly.

    Performance: Video streaming optimized for 2G/3G users.

    Scalability: Supports 100,000+ concurrent users.

    Security: User data encryption, secure login, anti-cheating checks.

    Localization: Swahili/English toggle support.

4. Architecture Overview

    3-Tier Architecture:

        Presentation Layer: Mobile/Web app

        Logic Layer: RESTful APIs for content, quizzes, rewards

        Data Layer: Centralized database (PostgreSQL + Redis for caching)

5. Constraints

    Many users may not have regular internet access.

    NECTA copyright sensitivity (need to rewrite questions).

    Rewards system must be sustainable (consider ad partnerships or donor funds).

6. Assumptions

    Partner teachers are available to contribute content and moderate groups.

    Schools will promote the platform if it supports their pass rates.

    Students have at least occasional access to smartphones.