Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bestbynature/todolist-webpack-es6
In this project, a simple HTML list of To Do tasks is built with html, CSS and javaScript. The list is styled according to the specifications listed in the project requirement and the entire app is bundled using webpack and served by a webpack dev server.
https://github.com/bestbynature/todolist-webpack-es6
css eslint html5 javascript
Last synced: 14 days ago
JSON representation
In this project, a simple HTML list of To Do tasks is built with html, CSS and javaScript. The list is styled according to the specifications listed in the project requirement and the entire app is bundled using webpack and served by a webpack dev server.
- Host: GitHub
- URL: https://github.com/bestbynature/todolist-webpack-es6
- Owner: Bestbynature
- License: mit
- Created: 2023-03-28T08:23:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-23T13:36:40.000Z (over 1 year ago)
- Last Synced: 2024-10-04T15:56:42.970Z (about 1 month ago)
- Topics: css, eslint, html5, javascript
- Language: JavaScript
- Homepage: https://bestbynature.github.io/TodoList-webpack-ES6/
- Size: 368 KB
- Stars: 15
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[To DO LIst\] ](#-to-do-list-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [**To-Do-List-App**](#to-do-list-app)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage ](#usage-)
- [Run tests ](#run-tests-)
- [Deployment ](#deployment-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**[To DO LIst](https://bestbynature.github.io/TodoList-webpack-ES6/)** is a a basic website that allows users to add and/or remove activities from a list of refistered activities on the website. The Project is achieved by using JavaScript objects and arrays. The project also implemented features that dynamically modify the DOM and add basic events and listeners..
Client
- HTML
- CSS
- JAVASCRIPT
- **[Linter checks]**
- **[Webpack]**
- **[Add/Remove buttons]**
- **[clear All completed button]**
### **[To-Do-List-App](https://bestbynature.github.io/TodoList-webpack-ES6/)**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- The current version of node
- To have Git installed on your local machine
- Node Package manager (npm)
- An editor such as Visual Studio Code
### Setup
Clone this repository to your desired folder:
- Create your classic access token from github.com
- run "git clone https://{access_token}@github.com/username/{repo_name}.git"
- Update your git identity by running "git config --global user.email "[email protected]""
- Update your name on git by running "git config --global user.name "your_name"
### Install
Install this project with:
```sh
- In the first commit of your feature branch create a .github/workflows folder and add a copy of [.github/workflows/linters.yml](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml) to that folder.
- create a .gitignore file and add 'node_modules' to it
- run 'npm init -y'
- run 'npm install --save-dev [email protected]'
- Copy [hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.hintrc) to the root directory of your project.
- run 'npx hint .'
- Fix validation errors.
- run 'npm install --save-dev [email protected] [email protected] [email protected] [email protected]'
- Copy [stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.stylelintrc.json) to the root directory of your project.
- Run 'npx stylelint "\*_/_.{css,scss}"'
- fix linter errors
- run "npm install --save-dev [email protected] [email protected] [email protected] [email protected]"
- Copy [eslintrc.json](https://github.com/microverseinc/linters-config/tree/master/html-css-js)
- Run npx eslint . on the root of your directory of your project
- Fix linter error.
### To Install Jest
- run npm install --save-dev jest
- add " "test": "jest", "watch": "jest --watch *.js" to the scripts section of package.json"
- run npm install --save-dev @babel/plugin-transform-modules-commonjs
- create a file at the root called .babelrc
- copy `{
"env": {
"test": {
"plugins": ["@babel/plugin-transform-modules-commonjs"]
}
}
}` inside the file
```
### Usage
To run the project, execute the following command:
```sh
use git bash to open in Vs code
use npm start to run web dev server
npm run build to get the production version
```
To run tests, run the following command:
```sh
Run "npx hint ."
Run "npx stylelint "**/*.{css,scss} --fix " to fix linters
Run "npx eslint . --fix to fix linters"
```
You can deploy this project using:
- github pages
```sh
- npm run deploy
```
👤 **Author**
- GitHub: [@githubhandle](https://github.com/Bestbynature)
- Twitter: [@twitterhandle](https://twitter.com/Dammybest)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/damilare-ismaila-4a5a8b30/)
- [ ] **[contact form page]**
- [ ] **[A feature for price inclusion]**
- [ ] **[A feature for updating the cart]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, kindly drop a star for me.
I would like to use this medium to appreciate [Microverse](https://microverse.org) for giving me this type of opportunity.
This project is [MIT](./LICENSE) licensed.