React Tutorial

📗 Table of Contents

• 📗 Table of Contents
• 📖 About the project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 About the project

React To-Do App is a To-Do List made with React, which uses concepts like routing, components, state, props, etc. In this app you can add different task, mark them as completed, and edit them as necessary.

🛠 Built With

Tech Stack

Client

• HTML, CSS, JS
• React.js

Key Features

• Allows users to create a persistent list of pending tasks
• Allows to edit, reorder, delete, and mark tasks as completed

(back to top)

🚀 Live Demo

• Live Demo Link (WIP)

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need to have Node.js installed in your system, which includes NPM, This is needed to get React and other packages.

Setup

First of all, clone this repository to your desired folder. Example:

  cd my-folder
  git clone https://github.com/cilfonegabriel/react-todo-app.git

Install

After cloning the repo, navigate into it and install all the required packages with the following command:

  npm install

Then just wait for everything to finish downloading.

Usage

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Run tests

To run tests, run the following command:

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Deployment

You can deploy this project using:

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

(back to top)

👥 Authors

👤 Gabriel -Cilfone

• GitHub: Gabriel Cilfone
• LinkedIn: Gabriel Cilfone

(back to top)

🔭 Future Features

• Complete the about pages
• Add reorder functionality
• Deploy a live demo
• Add account support to store your list

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

(back to top)

🙏 Acknowledgments

• Thanks to Microverse and all my teammates!

(back to top)

📝 License

This project is MIT licensed.

(back to top)