cancelei/To-do-list

Main learning points: Use Javascript to add, remove and display Tasks. Made during Microverse Coding School.

Responsive 'To-Do List' App

📗 Table of Contents

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

📖 Project Name

This project was elaborated during the Microverse Course, is it a To-Do app with minimalistic but user friendly features to register your To-do's in a different way, more old school and without all the fuss.

🛠 Built With Love and Passion

Tech Stack

Client

• HTML

Server

• N/A

Database

• N/A

Key Features

• Interactive List (Clear, add/Remove and mark as done the items);
• Basic Structure & Linters;
• Webpack & configs;

(back to top)

🚀 Live Demo

• Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Download Project Files from github.

Setup

Clone this repository to your desired folder:

Install

Install Node Package by running:

• npm install

Usage

• In other to use the repo you either to create a branch to create new features.
• But in order to run the project use the commands below:
  • npm run build (It will create a production ready file)
  • npm start (It will run the server on your local machine)

Run Linters (Testing)

I have added Linters different kinds of Linters to help avoid typos and ensure the best practices of the code base. So while using this repository if you need to check your work no matter if you have worked on HTML or CSS, or even JS you can use the commands below.

• To run the linter test on index.html or any HTML file. Use the below command: npx hint .

-To run linter test on Stylesheets (CSS or sass). Use the below command: npx Stylelint "**/*.{css,scss}"

• To run linter test on ES Lint (JS). Use the below command: npx eslint .

Deployment

N/A

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author Glauber Bannwart

• GitHub: @cancelei
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features / Initiatives

• Improved UX (CSS/JS).
• New user and Login Screen with respective customer journey history.
• Company Strategy planning to prevent Design Error's.

(back to top)

🤝 Contributing

N/A

⭐️ Show your support

N/A

(back to top)

🙏 Acknowledgments

📝 License

This project is MIT licensed.

(back to top)