Todo Application

A Todo application which adops the CRUD operations. A user can create, read, update, or delete a todo. It uses local storage to store the user's todos. The application is built using React and TypeScript. It employs CSS modules, too.

Table of Contents

1. Demonstration
2. Prerequisites
3. Getting Started
4. Contributing
5. Acknowledgements

Demonstration

Prerequisites

Before getting started, it is required to download & install the following:

• Nodejs LTS or current version works fine. It must be above version 14.

Getting Started

It is required to clone or fork this project to get started.

Clone this project by running the following command:

git clone https://github.com/cesarcode-init/react-typescript-todo-app.git

Then change directory:

cd react-typescript-todo-app

The application depends on multiple npm packages. To install these dependencies, run npm i or npm install.

npm install

To open the application in the browser, it is required to run the following command in the terminal:

npm start

The application should open at http://localhost:3000 in the development mode.

Contributing

To contribute to this project, the following steps are required:

1. Clone the repository:

git clone https://github.com/cesarcode-init/react-typescript-todo-app.git

2. Create a new branch:

git checkout -b BRANCH_NAME

3. Make the modifications.

4. Submit a Pull Request providing a description of modifications.

Acknowledgements

• React Icons.

License

This project is licensed under the MIT license.
Copyright © 2022, Kaissar Mouelhi

(back to top)