/react-todo-app

A simple Todo List app that allows users to add, edit and mark task tasks as completed.

Primary LanguageJavaScriptMIT LicenseMIT


React-Todo-App

📗 Table of Contents


📖 React-Todo-App

React-Todo-App is a website with a todo list functionalities which includes, users having the ability to add a task, edit a task and delete a task.

  • Add future task to complete.
  • Checkout already completed tasks.

🛠 Built With

Tech Stack

Technology
Tools

Key Features

  • Users have the ability to add a task, edit and delete
  • Users have the ability to strike through tasks when completed

(back to top)

🚀 Live Demo

  • Preview link would be up soon.

(back to top)

💻 Getting Started


Prerequisites

In order to reproduce the react-todo-app and be able to make changes for your own purpose you need the following tools:

  • Visual Studio Code
  • git-scm
  • A Github account
  • NodeJS (which also includes npm package manager)

Setup

  1. Make a new directory and go inside the directory using cd command in terminal
  2. Use "git" to clone this repository into your local drive:

    $ git clone https://github.com/skabeo/react-todo-app

  3. Run the command to install all necessary dependancies:

    npm install

Usage

  • Feel free to experiment with the project.
  • To build the project:

    npm run build

  • The index.html file in public folder is the output file that you want to open in the browser.
  • To add tests or examine different tests that are alreadt available go to:

    [root_dir]/src/modules/[modulename].test.js

Deployment

You can deploy this project by opening a new github repo and initialize the local git repo and connect it through: $ git remote add origin main [your github repo link] command. Then you can push the project into that repository and if you go to the repository in your account, you'll see the code in the account.

(back to top)

👥 Author

👤 Spencer Okyere

(back to top)

🔭 Future Features

  • A functional and well documented navlinks.
  • A timestamps for all tasks.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project consider giving a star to the project and if you want to go furthur make a donation to any one the top 8 charities in Hawaii islands at the link below:

(back to top)

🙏 Acknowledgments

  • I would like to thank Ibas Majeed for putting together a well documented article for the todo-list application.

(back to top)

❓ FAQ

  • Is mobile first web design a necessity these days?

    • Since 2014 mobile web users have surpassed desktop users and the rate of the new users being introduced to web by mobile devices will only increase by time.
  • Does the project support all platforms?

    • Yes! Since it is based on web technology, any device that has a web browser will be able to see the website once it is online.

(back to top)

📝 License

This project is MIT licensed.

(back to top)