📄 Todo List

       

About

Introducing Todo List, the ultimate open-source task manager application, developed using React and NextUi for managing your work and life. Todo List help's you become focused, organized, and calm. With its easy to use user-friendly design and interface you can create your todos within seconds without having to worry about anything over complicated.

Just type anything into the task field - add it and voila! Your first todo is ready to be completed.

Don't let your tasks go unorganized, make a to-do list today!

Major Technologies

• react
• nextui-org
• react-hook-form

Structure

├───Components
│   ├───Buttons
│   ├───Helpers
│   ├───Icons
│   ├───Layouts
│   └───List
│       └───Helpers
├───Contexts
├───Data
│   ├───Locales
│   ├───Table
│   └───Todos
├───Modules
├───Pages
│   └───User
│       ├───Settings
│       └───Tasks
│           ├───Components
│           │   └───Models
│           └───Contexts
├───Themes
└───Utils

Getting Started 🎉

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

💡Prerequisites

We recommend that you have a basic understanding of Node.js

Installation

# Clone the repository
$ git clone https://github.com/TheCoderRaman/TodoList.git
$ cd TodoList

Production

# Build for production
$ npm install
$ npm run build

Development

# Run the development server
$ npm install
$ npm start dev

Repository Branches

• master -> any pull request of changes this branch
• main -> don´t modify, this is what is running in production

Contributions

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

Pull Requests

1. Fork the repo and create your branch: #[type]/PR description
2. Ensure to describe your pull request: Edit the PR title by adding a semantic prefix like Added, Updated:, Fixed: etc. Title: #[issue] PR title -> #90 Fixed styles the button

Authors

• Raman Verma

Code of Conduct

In order to ensure that the Todo List community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within todo list, please send an e-mail to Raman Verma via e-mail. All security vulnerabilities will be promptly addressed.

License

The Todo List is open-sourced software licensed under the MIT License