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
- Languages: HTML, SASS and JavaScript
- Linters: Lighthouse, Webhint, Stylelint and ESlint
- Module Bundler: Webpack
- Module Bundler Loaders: Style, CSS and SASS
- Module Bundler Plugin: HtmlWebpackPlugin
- Code Editor: VS Code
Website Mockup 📱 💻 🖥️
Screenshots 📸
Screenshots can be found in the repository.
Live Demo 🔗
Check the live demo here👈
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
- A web browser like Google Chrome.
- 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 git@github.com:mavericks-db/todo-list.git
Usage
Kindly modify the files as needed.
Run tests
To check for linters, use the files provided by Microverse. 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
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Show your support
Give a ⭐️ if you like this project!
Acknowledgments
- Microverse
- Code Reviewers
- Coding Partners
📝 License
This project is MIT licensed.