Skip to content

Design and develop an accessible e-learning platform that caters to users with disabilities, focusing on usability and user experience. The platform will allow users to create and share courses, track progress, and provide real-time feedback.

License

Notifications You must be signed in to change notification settings

sdz4/accessible-e-learning-platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

🤖 CURSOR AI INSTRUCTIONS

IMPORTANT: This section is only for Cursor AI and will be completely removed after processing


AI Task: Complete README Transformation

Hello Cursor AI! Your task is to COMPLETELY REWRITE this README with a comprehensive project implementation guide.

Critical Requirements:

  1. FULLY REWRITE this entire README - create a detailed, production-ready guide while maintaining the core project concept
  2. Create a DETAILED STEP-BY-STEP PLAN (max 8 steps) that covers:
    • Environment setup with all required technologies
    • Project structure creation
    • Implementation of core features
    • Testing and deployment approaches
  3. Tailor content to the user's profile:
    • User's Experience Level: Intermediate
    • User's Available Time: A Few Weeks
  4. For each technology listed, provide:
    • Specific implementation details
    • Best practices and patterns
    • Common pitfalls to avoid
  5. Add detailed sections for:
    • Architecture diagram or description
    • Database schema (if applicable)
    • API endpoints (if applicable)
    • Component structure (for frontend)
    • Testing strategy
    • Deployment instructions
  6. Provide code examples for critical project parts
  7. REMOVE THESE INSTRUCTIONS COMPLETELY after your rewrite

Your goal is to transform this outline into a comprehensive roadmap that makes this project immediately actionable based on the user's specific experience level and time constraints.

⚠️ CRITICAL FIRST STEP ⚠️

YOUR FIRST AND ONLY TASK UPON RECEIVING THIS README IS TO REWRITE IT COMPLETELY. DO NOT START IMPLEMENTING THE PROJECT OR WRITING ANY CODE YET.

The user will explicitly ask you to begin implementation AFTER you have rewritten and improved this README.

Accessible E-Learning Platform

Project Overview

Design and develop an accessible e-learning platform that caters to users with disabilities, focusing on usability and user experience. The platform will allow users to create and share courses, track progress, and provide real-time feedback.

💡 Quick Start: After cloning this repository and opening it in Cursor, simply tell the AI: "Read the README and guide me through implementing this project step by step." Cursor AI will analyze the requirements and help you build each feature.

User Profile

  • Experience Level: Intermediate
  • Available Time to Complete: A Few Weeks

Technologies

  • React: Used for building the front-end of the application, providing a rich and interactive user interface
  • Redux: Used for state management, ensuring a seamless user experience and efficient data handling
  • Node.js: Used for building the back-end API, handling user authentication, and storing course data
  • Express.js: Used as a web framework for building the back-end API, providing a robust and scalable infrastructure
  • MySQL: Used as a relational database management system, storing user data, courses, and progress tracking information
  • WCAG 2.1 Guidelines: Used as a set of guidelines for ensuring the platform is accessible and usable for users with disabilities

Development Steps

1. Research and Planning

Research accessibility guidelines, identify target audience, and plan the platform's features and functionality

2. Front-end Development

Design and develop the front-end of the application using React, focusing on accessibility and usability

3. Back-end Development

Build the back-end API using Node.js and Express.js, implementing user authentication and course data storage

4. Database Integration

Integrate the MySQL database with the back-end API, ensuring data is stored and retrieved efficiently

5. Testing and Debugging

Test the platform for usability, accessibility, and functionality, identifying and fixing bugs and issues

6. Deployment

Deploy the platform to a production environment, ensuring scalability and reliability

Main Features

Features will be added soon

Sample Code

// An example code snippet
function handleKeyPress(event) {
  if (event.key === 'Enter') {
    // Handle enter key press
  }
}

Getting Started

Instructions will be added soon

Resources

AI Coding Prompts

Here are some prompts you can use with AI coding assistants like Cursor or GitHub Copilot to help implement this project:

Prompt 1

Implement the React front-end for the accessible e-learning platform by creating a new React application using `npx create-react-app` and setting up the basic file structure. Then, integrate the `Redux` library for state management and create a `store.js` file to handle global state. Finally, create a `Header` component that includes a search bar and a navigation menu.

Prompt 2

Develop the core functionality for the platform by creating a `Course` component in React that allows users to create, read, update, and delete courses. Use the `Node.js` back-end API to interact with the `MySQL` database and store course data. Implement authentication using the `Express.js` framework and ensure that only authorized users can access and modify course data.

Prompt 3

Enhance the platform's accessibility features by implementing keyboard navigation for the `Course` component. Use the `WCAG 2.1 Guidelines` to ensure that the component is usable for users with disabilities. Additionally, integrate screen reader support and implement ARIA attributes to provide a better user experience for screen readers.

Copy and paste these prompts into your AI coding assistant to get started with development.


Generated by CodeSpark

About

Design and develop an accessible e-learning platform that caters to users with disabilities, focusing on usability and user experience. The platform will allow users to create and share courses, track progress, and provide real-time feedback.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published