tomdan-ai/To-do-list

The to do list is a javascript project built with webpack to keep track of the activities a user does

To-Do-List README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [GDC Capstone Project]

To-Do-List

The to do list is a javascript project built with webpack to keep track of the activities a user does

🛠 Built With

HTML CSS Webpack Javascript

Key Features

• [Linters]
• [CSS]
• [Webpack]
• [HTML]
• [JAVASCRIPT]

(back to top)

Live Demo <a name"Live-demo">

Click here to see a live demo of the To-do List Project

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. -[] Navigate into desired folder -[] Clone the repository

sh git clone https://github.com/tomdan-ai/To-do-list.git cd To-do-list

Prerequisites

In order to run this project you need:

 npm run build
 npm init -y
 npm install --save-dev hint@7.x
 npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x
 npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

Setup

Clone this repository to your desired folder:

-[] Navigate into desired folder -[] Clone the repository

sh git clone https://github.com/tomdan-ai/Capstone-redo.git cd Capstone-redo

Install

Install this project with:

  cd To-do-list
  npm install

Usage

To run the project, execute the following command:

    cd To-do-list
    npm install -g live-server

Run tests

To run tests, run the following command:

  npx hint .
  npx stylelint "**/*.{css,scss}"
  npx eslint .

Deployment

You can deploy this project using:

Github pages

(back to top)

👥 Authors

👤 TOM DANIEL

• GitHub: @tomdan-ai
• Twitter: @kingWebstar
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Animations: I will love to add some animations to the navbar in future]
• [HTML: I will design and deploy the remaining pages in the website]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a star

(back to top)

🙏 Acknowledgments

I would like to thank all my coding partners for the support

(back to top)

❓ FAQ (OPTIONAL)

• [How long did it take to finish the projects]

  • [Its still under construction]

• [Were any linters used]

  • [Yes they were used and can access them in this link https://github.com/microverseinc/linters-config/tree/master/html-css-js]

• [Did you use webpack]

• [Yes they were used and can access them in this link https://webpack.js.org/guides/getting-started/#basic-setup]

(back to top)

📝 License

This project is MIT licensed.

(back to top)