https://github.com/mavericksbalitaan/todo-list
Microverse Module 02 Project: This educational project is to make a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. Built with HTML, Sass, JavaScript and Webpack.
https://github.com/mavericksbalitaan/todo-list
css css-loader css3 html html5 htmlwebpackplugin javascript localstorage microverse microverse-projects microverse-students sass sass-loader scss style-loader todo todoapp todolist webpack
Last synced: 3 months ago
JSON representation
Microverse Module 02 Project: This educational project is to make a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. Built with HTML, Sass, JavaScript and Webpack.
- Host: GitHub
- URL: https://github.com/mavericksbalitaan/todo-list
- Owner: mavericksbalitaan
- License: mit
- Created: 2022-04-22T11:46:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-10T13:23:43.000Z (almost 3 years ago)
- Last Synced: 2025-01-15T05:47:52.615Z (4 months ago)
- Topics: css, css-loader, css3, html, html5, htmlwebpackplugin, javascript, localstorage, microverse, microverse-projects, microverse-students, sass, sass-loader, scss, style-loader, todo, todoapp, todolist, webpack
- Language: HTML
- Homepage: https://mavericks-db.github.io/todo-list/dist/index.html
- Size: 1.44 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# To-do List
> This is an educational project to make a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete.
## Built With
- [x] Languages: HTML, SASS and JavaScript
- [x] Linters: Lighthouse, Webhint, Stylelint and ESlint
- [x] Module Bundler: Webpack
- [x] Module Bundler Loaders: Style, CSS and SASS
- [x] Module Bundler Plugin: HtmlWebpackPlugin
- [x] Code Editor: VS Code
## Website Mockup 📱 💻 🖥️
## Screenshots 📸
Screenshots can be found in the repository.
## Live Demo 🔗
Check the live demo [here](https://mavericks-db.github.io/todo-list/dist/index.html)👈
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- [x] A web browser like Google Chrome.
- [x] A code editor like Visual Studio Code with Git and Node.js.
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for Node.js and npm for package installation.
```
$ node --version && npm --version
```
### Setup
Clone the repository using the GitHub link provided below.
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone [email protected]:mavericks-db/todo-list.git
```
### Usage
Kindly modify the files as needed.
### Run tests
To check for linters, use the files provided by [Microverse](https://github.com/microverseinc/linters-config). A GitHub action is also set to run during pull request.
```
$ npm install
```
### Deployment
This app is deployed in the GitHub Pages for easy viewing upon merged on the main branch.
Please find the link in the Live Demo section.
## Authors
👤 **Mavericks Balitaan** 
[](https://github.com/mavericks-db) [](https://twitter.com/mavericks_db) [](https://www.facebook.com/mavericksdb/) [](https://www.linkedin.com/in/mavericks-db/) [](mailto:[email protected])
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/mavericks-db/todo-list/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners
## 📝 License
This project is [MIT](./MIT.md) licensed.