Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 2.3 KB

README.md

File metadata and controls

74 lines (45 loc) · 2.3 KB
Raw

Project Name : Todo list

This a simple todo list app put together using webpack.

Built With

  • Major languages : HTMl & CSS, JavaScript
  • Technologies used : Github, Git and Linters

Live Demo (Coming soon)

Getting Started

This project is open source and you are free take modify and do with as you wish. To get a local copy up and running follow these simple example steps.

Prerequisites ♻️

  • Any modern browser.
  • A local version control like git installed on your computer
  • Code editor (Visual studio code, sublime text, notepad++, ...) installed on your computer;
  • Knowledge of basic of HTML and CSS.

Setup 🎰

  • Click this link to clone down the source code or download it as a zip file

Install

  • Once you have the code navigate into the root folder and run npm install to get all dependecies required to run the linters checks and set up webpack

Run test 🧪

Run the commands below in the terminal or git bash.

  • npx hint . : for the html codebase and use of best practices.
  • npx stylelint "**/*.{css,scss}" : for the css codebase and use of best practices. you can add
  • npx eslint . : for the JavaScript codebase and use of best practices.

  • Note that you can add --fix keyword to the command for Css and/or JavaScript to make sure that you avoid all errors comming from your code editor

  • To start webpack server run npm start

Authors

👤 Cecilia Mukima

🤝 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
  • IHat tip to anyone whose code was used for inspiration

📝 License

This project is MIT licensed.