Skip to content

ONJoseph/react-todoapp

Repository files navigation

logo

Microverse README Template

📗 Table of Contents

📖 [react-todoapp]

[react-todoapp] is a website that allows you to create a list of task that you want to do online easily. Its a learning project with the objectives of using JavaScript events, using React life cycle methods and understanding the mechanism of lifting state up as well as consolidating knowledge about React, components, props, state, and hooks. The finished product is a To do app!

🛠 Built With

Tech Stack

Client/Server
- HTML, CSS, JavaScript and JSX - Git, Github and Visual Studio Code - Webpack - React

Key Features

  • [About Page]
  • [Add and remove tasks]
  • [NotMatch Page]

(back to top)

## 🚀 Live Demo
  • [Live Demo Link](No deployment yet)

(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:

  • Internet connection and browser
  • A source code editor(preferably Visual Studio Code)
  • Browser
  • Install nodeJS along with NPM

Setup

Clone this repository to your desired folder:

Install

Install this project with:

  • Git
  • Node
  • Run npm i on the root of the project and you're good to go. All of the necessary packages will be installed for you!
  • npm init -y
  • npm install webpack webpack-cli --save-dev
  • npm install --save-dev html-webpack-plugin
  • npm install --save-dev style-loader css-loader
  • npm install --save-dev webpack-dev-server

Usage

To run the project, execute the following command:

  • Clone the repository using <https://github.com/ONJoseph/react-todoapp.git>
  • Change directory into the project folder: cd react-todoapp
  • Run npm install
  • Run npm start
  • A new browser will open automatically with application loaded

Available Scripts

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 test

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

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.

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.

Deployment

You can deploy this project using:

  • Run npm run build for Webpack to generate the dist files corresponding to your actual /src file

(back to top)

👥 Authors

(back to top)

🔭 Future Features

  • [Exercise: Deploy]
  • [Some Cool animations]
  • [Implement Testing (pair programming)]

(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 please give a ⭐️ to show your support!

(back to top)

🙏 Acknowledgments

I would like to thank:

  • Microverse for the Readme Template

(back to top)

📝 License

This project is MIT licensed.