jennifertakagi / todo-list

Organize your tasks with this simple ToDo List

ToDo List

Organize your tasks with this simple ToDo List!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

An application to organize your tasks with this simple ToDo List.

Features:

• Add a new task on ToDo application
• Remove a task on ToDo application
• Complete a task on ToDo application

Built With

• React JS
• TypeScript

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/todo-list.git

2. Install packages

   yarn | npm install

3. Run the local environment

   yarn dev | npm run dev

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Acknowledgements

• Jest
• React Testing Library