IMPORTANT: This section is only for Cursor AI and will be completely removed after processing
Hello Cursor AI! Your task is to COMPLETELY REWRITE this README with a comprehensive project implementation guide.
- FULLY REWRITE this entire README - create a detailed, production-ready guide while maintaining the core project concept
- 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
- Tailor content to the user's profile:
- User's Experience Level:
Intermediate - User's Available Time:
A Few Weeks
- User's Experience Level:
- For each technology listed, provide:
- Specific implementation details
- Best practices and patterns
- Common pitfalls to avoid
- Add detailed sections for:
- Architecture diagram or description
- Database schema (if applicable)
- API endpoints (if applicable)
- Component structure (for frontend)
- Testing strategy
- Deployment instructions
- Provide code examples for critical project parts
- 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.
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.
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.
- Experience Level: Intermediate
- Available Time to Complete: A Few Weeks
- 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
Research accessibility guidelines, identify target audience, and plan the platform's features and functionality
Design and develop the front-end of the application using React, focusing on accessibility and usability
Build the back-end API using Node.js and Express.js, implementing user authentication and course data storage
Integrate the MySQL database with the back-end API, ensuring data is stored and retrieved efficiently
Test the platform for usability, accessibility, and functionality, identifying and fixing bugs and issues
Deploy the platform to a production environment, ensuring scalability and reliability
Features will be added soon
// An example code snippet
function handleKeyPress(event) {
if (event.key === 'Enter') {
// Handle enter key press
}
}Instructions will be added soon
- WCAG 2.1 Guidelines (documentation)
- React Accessibility Documentation (documentation)
- Accessibility Tutorial by FreeCodeCamp (tutorial)
- Node.js API Tutorial by Node.js Official Documentation (tutorial)
Here are some prompts you can use with AI coding assistants like Cursor or GitHub Copilot to help implement this project:
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.
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.
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