Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/estete9/todolist

A todo list that can add various elements and gets saved in LocalStorage
https://github.com/estete9/todolist

Last synced: 24 days ago
JSON representation

A todo list that can add various elements and gets saved in LocalStorage

Awesome Lists containing this project

README

        


logo

Todolist - Let's DO

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Run](#run)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 TodoList

**TodoList** This is the 2nd block project that:

- Adds a new item.

- Removes a selected item.

- Marks a selected item as complete.

- Removes all items marked as complete at once.

- Reorders a selected item (as drag-and-drop, as an additional feature).

## 🛠 Built With

### Tech Stack

Client

Module

### Key Features

- **[Responsive design for mobile and desktop]**
- **[Menu functionality using JavaScript]**
- **[Use of modules and libraries]**

(back to top)

## 🚀 Live Demo

- [TodoList Live Demo](https://todolist-minimalist.netlify.app)

(back to top)

## 💻 Getting Started

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

### Prerequisites

To run this project you need:
- **Node.js and npm (or yarn):** These are required to run the build process and development server.
You can download them from [https://nodejs.org/](https://nodejs.org/).

### Setup

1. **Clone the repository:** Use `git clone https://github.com/Estete9/TodoList.git` to clone the repository to your local machine.
1. **Install dependencies:** Navigate to the project directory and run `npm install` (or `yarn install`) to install all the necessary libraries used in the project.
1. **Build the project:** Run `npm run build` (or `yarn build`) to create an optimized production-ready version of the code.

### Run
1. **Start the development server:** Run `npm start` (or `yarn start`) to launch a local development server. This will typically start the application on a port like `http://localhost:3000` (the exact port might vary). You can then access the project in your browser.
### Usage

Once the development server is running, you can access the project in your browser by visiting `http://localhost:9000` (or the port specified in your `webpack.config.js` file).

### Run tests

You can run the automated tests using the following command:
1. `npm run watch-jest` # or yarn run watch-jest\
2. press `a` to run all test cases

(back to top)

## 👥 Authors

👤 **Esteban Palacios**

- GitHub: [@Estete9](https://github.com/Estete9)
- Twitter: [@NaughTban](https://twitter.com/NaughTban)
- LinkedIn: [Esteban Palacios](https://www.linkedin.com/in/esteban-palacios-5030a772/)

👤 **Alejandro Maggioni**

- GitHub: [@githubhandle](https://github.com/alex1779/)
- Twitter: [@twitterhandle](https://twitter.com/alex1779)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/alejandro-maggioni-086678b5/)

(back to top)

## 🔭 Future Features

- **Gallery popup**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Estete9/TodoList/issues).

(back to top)

## ⭐️ Show your support

If you like this project remember to star and share it 🥳️

(back to top)

## 🙏 Acknowledgments

- ACKNOWLEDGMENTS TO CREATIVE LICENSE AND OTHERS

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)