Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lily4178993/to-do-list
"To-do list" is 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.
https://github.com/lily4178993/to-do-list
css3 es6-javascript eslint html5 stylelint todo-list webhint webpack
Last synced: 21 days ago
JSON representation
"To-do list" is 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.
- Host: GitHub
- URL: https://github.com/lily4178993/to-do-list
- Owner: lily4178993
- Created: 2023-06-14T08:27:39.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-06-18T09:42:58.000Z (5 months ago)
- Last Synced: 2024-10-08T15:55:00.296Z (about 1 month ago)
- Topics: css3, es6-javascript, eslint, html5, stylelint, todo-list, webhint, webpack
- Language: JavaScript
- Homepage: https://lily4178993.github.io/To-do-list/dist/
- Size: 1000 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
To Do List
////////////////////////////////////////////
# Table of Contents 📗
- [About the Project 📖](#about-project)
- [Built With](#built-with) 🛠
- [Tech Stack 🗜️](#tech-stack)
- [Key Features 🏷️](#key-features)
- [Screenshot](#screenshot)
- [🚀 Live Demo](#live-demo)
- [Getting Started 💻](#getting-started)
- [Setup ⚙️](#setup)
- [Prerequisites 🧱](#prerequisites)
- [Install 🏗️](#install)
- [Usage 📂](#usage)
- [Run tests 🧪](#run-tests)
- [Deployment](#deployment)
- [Author 👤](#author)
- [Future Features 🔭](#future-features)
- [Contributing 🤝](#contributing)
- [Show your support 🌟](#support)
- [Acknowledgements 🙏](#acknowledgements)
- [License 📝](#license)
**To-do list** is 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.
Client
-
HTML5 markup to build raw structure of this web page -
CSS3 custom properties, FlexBox, Grid to make the website visually attractive - Javascript
-
Linters for coding convention and coding formating - Webpack
Server
- **Adding a new item**
- **Removing a selected item**
- **Marking a selected item as complete**
- **Removing all items marked as complete at once**
## Screenshot 📷
Below is an overview of the app.
This project is hosted on [GitHub pages](#deployment), so if you want to check it online, please click 😊 [here](https://lily4178993.github.io/To-do-list/dist/).
To get a local copy up and running, follow these steps.
In order to run this project you need:
- A Github account
- Node JS
- Webpack
- A web browser to view output e.g [Microsoft Edge](https://www.microsoft.com/en-us/edge).
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/lily4178993/To-do-list.git
```
- Navigate to the folder
```
cd my-folder
cd To-do-list
```
- Checkout the branch
```
git checkout master
```
Install all dependencies:
```sh
npm install
```
To run the project, open your terminal and tap the following line.
```sh
npm run build
```
```sh
npm start
```
### Run tests 🧪
How should it be tested?
To run tests, run the following command:
- HTML linter errors run:
```
npx hint .
```
- CSS linter errors run:
```
npx stylelint "**/*.{css,scss}" --fix
```
- JavaScript linter errors run:
```
npx eslint . --fix
```
You can deploy this project using: GitHub Pages, [Vercel](https://vercel.com/) or [Netlify](https://www.netlify.com/).
This project was deployed using GitHub Pages. For more information about how to use GitHub pages [read here](https://www.w3schools.com/git/git_remote_pages.asp?remote=github) 🤩. If you want to watch a video about how to use GitHub pages instead of reading [click here](https://www.youtube.com/watch?v=QyFcl_Fba-k&t=251s).
**Nelly Telli**
- GitHub: [@lily4178993](https://github.com/lily4178993/)
- Twitter: [@nelly_telli](https://twitter.com/nelly_telli)
- LinkedIn: [Nelly T.](https://www.linkedin.com/in/nelly-t-330414266/)
- **Make the app responsive**
- **Reordering a selected item (as drag-and-drop)**
If you have suggestions 📝, ideas 🤔, or bug reports 🐛, please feel free to open an [issue](https://github.com/lily4178993/To-do-list/issues) on GitHub.
Remember, every contribution, no matter how big or small, makes a difference.
Thank you for taking the time to explore my GitHub project! Your support means a lot to me. If you find my project valuable and would like to contribute, here are a few ways you can support me:
- Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.
- Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.
- Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.
I would like to express my sincere gratitude to [Microverse](https://github.com/microverseinc), the dedicated reviewers, and my partners. Your unwavering support, feedbacks, and collaborative efforts have played an immense role in making this journey a resounding success. Thank you for being an integral part of my achievements.
I would also like to thank Icons8 for all the images and icons I used in this project.
This project is [MIT](./MIT.md) licensed.