Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jesusgraterol/todo-list-top

This application allows the user to manage lists of chores as well as their states and it is the submission for The Odin Project: Todo List.
https://github.com/jesusgraterol/todo-list-top

theodinproject theodinproject-nodejs theodinprojectfoundations

Last synced: about 2 months ago
JSON representation

This application allows the user to manage lists of chores as well as their states and it is the submission for The Odin Project: Todo List.

Awesome Lists containing this project

README

        

# Todo List

![Todo List](./readme-assets/screenshot-01.png)

This application allows the user to manage lists of chores as well as their states and it is the submission for [The Odin Project: Todo List](https://www.theodinproject.com/lessons/node-path-javascript-todo-list).

The key features are:

- Add any number of tasks
- Group tasks into categories|projects
- Manage the state of tasks
- The user's data is stored privately in LocalStorage
- Cross-Platform Compatibility

## Live Demo

[Todo List](https://jesusgraterol.github.io/todo-list-top/)

## Getting Started

### Requirements

- GIT
- NodeJS ^v21.0.0
- NPM ^v10.2.0

### Installation

1) Clone the repository
```bash
git clone [email protected]:jesusgraterol/todo-list-top.git
```

2) Install the dependencies
```bash
npm install
```

## Usage

1) Run the Webpack Build in `watch` mode

```bash
npm run serve
```

2) Open the `./dist/index.html` file with your favorite browser.

## Build Process

1) Run the Webpack Build
```bash
npm run build
```

## Deployment

1) Push the new build to the `gh-pages` branch so it is deployed to **Github Pages**:

```bash
git subtree push --prefix dist origin gh-pages
```

## Built With

- HTML5
- CSS3
- JavaScript
- Webpack

## Running the Tests

```bash
# Unit Tests
N/A

# Integration Tests
N/A

# E2E Tests
N/A
```

## @TODO

N/A

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Acknowledgments

- [Google Fonts](https://fonts.google.com/icons)
- [Webpack](https://webpack.js.org/)
- [RxJS](https://rxjs.dev/)
- [uuidjs](https://github.com/uuidjs/uuid)