-
Notifications
You must be signed in to change notification settings - Fork 35
Open
Labels
Milestone
Description
Build a Sample Todo Application
Description:
Build a sample Todo application to demonstrate the features of the boilerplate. This application will serve as a reference for developers and showcase the boilerplate’s capabilities, including authentication, theming, and notifications.
As part of this issue, ensure that all task-related code is removed from the boilerplate, keeping the boilerplate clean and general-purpose.
Features:
-
Frontend:
- A React app with components for adding, editing, viewing, and deleting tasks.
- Support for theming and responsiveness to showcase styling capabilities.
-
Backend:
- CRUD APIs for managing tasks.
- JWT-based authentication to secure APIs.
- Integration with the notification system for sending reminders.
-
Database:
- Use MongoDB to store task data with fields such as title, description, status, and due date.
Steps:
-
Fork the Boilerplate:
- Set up the boilerplate as a new project for the Todo app.
-
Implement Features:
- Create CRUD functionality for tasks on the backend and frontend.
- Integrate the notification system to send reminders for overdue tasks.
-
Clean the Boilerplate:
- Remove all task-related code from the boilerplate to ensure it remains generic.
-
Deployment:
- Deploy the sample Todo application to the cloud using the boilerplate’s deployment solution.
-
Documentation:
- Provide detailed documentation on the sample app, explaining how it was built and how it demonstrates the boilerplate’s capabilities.
Acceptance Criteria:
- Fully functional Todo application demonstrating key boilerplate features such as:
- Authentication
- Theming
- Notifications
- All task-related code is removed from the original boilerplate to keep it generic.
- Documentation for developers, including a step-by-step guide on building the sample app.
- The sample application is deployed and hosted live as a reference project.
Additional Notes:
- The goal is to ensure the boilerplate remains clean and reusable while using the sample app as a reference for its features.
- Ensure robust testing for all functionality in the sample app.