📗 Table of Contents
To Do List App
To Do List App This project consists of creating a To Do List web application with html, css, javascript (ES6) using the webpack tool as a packager for all the application files.
🛠 Built With
Tech Stack
Key Features
- Minimalist Design
- Drag & drop functionality
- Responsive design
- Use of semantic HTML
- source code packaged with Webpack
- Unit test with jest
Video Demo
This is a video demonstration of the functionality of the application in different browsers:
🚀 Live Demo
To see the application working live, you can click on the following link that contains the demo version:
💻 Getting Started
To get a local copy up and running, follow these steps.
Setup
Clone this repository to your desired folder:
cd my-folder-name
git clone git@github.com:NitBravoA92/project-to-do-list.git
Prerequisites
In order to install, modify and run this project, it is necessary to have the following applications installed:
It is also important to have at least basic knowledge about webpack tool, HTML, CSS and Javascript languages so you will be able to understand and work with the html and css code of the project.
Install
Install this project by running the next command into your project folder:
npm install
All the packages and libraries necessary for the project to work will be installed in a folder called /node_module
Usage
Run the following command to start the application on a development server:
npm start
You only need to run this command once. If you keep making changes to the files, the installed webpack server will reload the page so you can see the changes immediately.
Open the HTML, CSS or Javascript files and modify the internal code, then run the following command to check if your code has any syntax, indentation or spacing errors:
HTML Linter
npm start
CSS Linter
npx stylelint "**/*.{css,scss}"
Javascript Linter
npx eslint .
Run test
npm run test
This will show you a log with details about errors (if any) and changes that would be necessary to solve those errors and improve the code.
Note: Please only modify the HTML, CSS and Javascript files. Do not modify the configuration files of the project.
When all the code changes are ready, run the following command to have webpack generate the bundle files in your ./dist folder. Those files are optimized for use in production.
npm run build
👥 Authors
👤 Nitcelis Bravo
👤 Andrea Manuel
🔭 Future Features
🤝 Contributing
Contributions, issues, suggestions and feature requests are welcome!
Feel free to check the issues page.
To do Contributions, please fork this repository, create a new branch and then create a Pull Request from your branch. You can find detailed description of this process in: A Step by Step Guide to Making Your First GitHub Contribution by Brandon Morelli
⭐️ Show your support
If you liked this project, give me a "Star" (clicking the star button at the beginning of this page), share this repo with your developer community or make your contributions.
🙏 Acknowledgments
I would like to thank my Microverse teammates for their support. They have supported me a lot in carrying out this project, giving me suggestions, good advice and solving my code doubts.
📝 License
This project is MIT licensed.