Skip to content

Aryan3522/Todo-List

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

22 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ TodoList β€” Next.js Task Management App

A modern Todo List application built using Next.js 14, React 18, TailwindCSS, and Material UI. The goal of this project is to provide a clean task management experience while also serving as a learning-friendly open source project for developers who want to contribute and improve their full-stack skills.

This repository is intentionally structured to encourage real-world collaboration workflows, similar to how production teams operate.


πŸš€ Tech Stack

Category Technologies
Framework Next.js 14
UI Library React 18
Styling TailwindCSS
UI Components Material UI
Icons Lucide React + MUI Icons
Animation Anime.js
Tooling PostCSS, Autoprefixer

πŸ“Έ UI Preview

Home Page

Home Page

Add Monthly Task

Add Monthly Task

Add Daily Task

Add Daily Task

Daily Task Page

Daily Task Page

Monthly Task Page

Monthly Task Page

πŸ“¦ Installation & Local Setup

Follow these steps to run the project locally.

1️⃣ Clone the repository

git clone https://github.com/<your-username>/todolist.git

2️⃣ Navigate to the project directory

cd todolist

3️⃣ Install dependencies

npm install

4️⃣ Run the development server

npm run dev

Now open:

http://localhost:3000

πŸ“ Project Scripts

Command Purpose
npm run dev Runs development server
npm run build Builds production bundle
npm start Runs production build
npm run lint Runs ESLint checks

🀝 Contributing Guidelines

This project welcomes contributions from developers of all experience levels. However, contributions must follow clear standards to maintain project quality.

Please read these rules carefully before submitting a pull request.


πŸ“Œ Contribution Rules

1️⃣ UI Changes

If your contribution modifies the user interface, you must:

β€’ Include before and after screenshots in the Pull Request β€’ Explain what UI component was modified β€’ Describe why the change improves the UI

Example:

Feature: Improved Task Card Layout

Changes:
- Added hover animation
- Improved checkbox styling
- Updated spacing for readability

Impact:
Better visual hierarchy and improved interaction feedback

2️⃣ Backend or Logic Changes

If your contribution modifies logic, state management, or APIs, you must:

β€’ Clearly explain what was changed β€’ Provide usage examples β€’ Describe the impact on application behavior

Example:

Feature: Optimized Task Completion Logic

Changes:
- Updated reducer logic for task state updates
- Reduced unnecessary re-renders

Example Usage:
dispatch({
  type: "TASK_COMPLETED",
  payload: { month: 2, index: 4 }
})

Impact:
Improves state update performance and prevents UI flickering

3️⃣ Code Quality Standards

All contributions must follow these rules:

βœ” Use clean and readable code βœ” Follow existing project structure βœ” Avoid unnecessary dependencies βœ” Write meaningful commit messages βœ” Test your changes before submitting a PR

Pull requests that do not follow these guidelines may be rejected.


πŸ”„ Contribution Workflow

Follow this workflow when contributing.


Step 1 β€” Fork the Repository

Click the Fork button at the top right of the repository page.

This creates your own copy of the project.


Step 2 β€” Clone Your Fork

git clone https://github.com/<your-username>/todolist.git

Step 3 β€” Create a New Branch

Never work directly on main.

git checkout -b feature/your-feature-name

Example:

feature/improve-checkbox-ui

Step 4 β€” Make Your Changes

Update the code, test your changes locally, and ensure everything works.


Step 5 β€” Commit Your Changes

git add .
git commit -m "feat: improved checkbox UI with animations"

Step 6 β€” Push to Your Fork

git push origin feature/your-feature-name

Step 7 β€” Create a Pull Request

Go to your fork on GitHub and click:

New Pull Request

Provide:

β€’ A clear description of your changes β€’ Screenshots (if UI updates) β€’ Examples (if backend updates)


🧠 Good First Contributions

If you are new to open source, you can start with:

β€’ UI improvements β€’ Accessibility improvements β€’ Performance optimizations β€’ Code refactoring β€’ New task management features


🌍 Open Source Mission

This project is open for contributions from developers who want to learn, build, and collaborate.

Whether you are a beginner exploring open source or an experienced developer improving the architecture, your contributions are welcome.


⭐ Support the Project

If you found this project helpful:

Don't just fork β€” star too ⭐

It helps the project grow and reach more developers.


πŸš€ Final Note

This project is completely free for newcomers to explore the codebase, understand how things work, and build something crazy together.

Let’s learn, collaborate, and ship great software.

Happy coding πŸ‘¨β€πŸ’»

About

A clean and intuitive Todo List application designed to help users organize their tasks efficiently. Users can create and manage daily or monthly todos, making it easy to track short-term and long-term goals. The application features a modern, eye-catching UI that enhances usability and provides a smooth task management experience.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors