https://github.com/lucaslinyker/todolist
A task manager project
https://github.com/lucaslinyker/todolist
commit-conventions css-modules phosphor-icons react vite
Last synced: 3 months ago
JSON representation
A task manager project
- Host: GitHub
- URL: https://github.com/lucaslinyker/todolist
- Owner: lucaslinyker
- Created: 2024-05-25T18:54:36.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-12-26T17:45:16.000Z (5 months ago)
- Last Synced: 2024-12-26T18:28:30.368Z (5 months ago)
- Topics: commit-conventions, css-modules, phosphor-icons, react, vite
- Language: JavaScript
- Homepage: https://todo-list-lucaslinykers-projects.vercel.app/
- Size: 27.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ToDoList
A essential project for organizes your tasks.
Explore the Codes »
View Live
·
Report Bug
·
Request Feature
Summary
## Overview
### Short Video
### Features
#### Main
- [x] Create a task
- [x] Delete a task
- [x] Mark a task as done
#### Futures
- [ ] Edit a task
- [ ] Light mode
- [ ] Save tasks in local storage
- [ ] Create a login system
- [ ] Save tasks in Firebase
## My Process
### Built With
### What I Learned
I learned how to style a React application using CSS Modules. I also learned how to use the useState hook and how to create a simple application using React. In this project also I use a the Phosphor Icons.
```jsx
import { PlusCircle } from '@phosphor-icons/react'
```
### Continued development
I intend to continue developing this project by adding new features and improving the existing ones. I also intend to improve my knowledge in React.
### Useful resources
- [CSS Modules](https://create-react-app.dev/docs/adding-a-css-modules-stylesheet/) - This article helped me to understand how to use CSS Modules in a React application.
- [Phosphor Icons](https://phosphoricons.com/) - This is a great website that helped me to find icons for my project.
- [Vite Documentation](https://vitejs.dev/guide) - This helped me to understand how to use Vite and how to create a React application using it. I really liked this tool and I will use it in my next projects.
- [React Documentation](https://reactjs.org/docs/getting-started.html) - This is an amazing documentation that helped me to understand the basics of React and how to create a simple application using it.
- [Rocketseat - React course](https://www.rocketseat.com.br/formacao/react) - This course helped me to understand the basics of React and how to create a simple application using it. OBS: I only did the first module, because I did it when they released the platform for free for 2 days.
## How to Install
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer.
To install the project, follow these steps:
```bash
# Clone this repository
$ git clone https://github.com/lucaslinyker/todoList.git
# Go into the repository
$ cd todoList
# Install dependencies
$ npm install
# Run the app
$ npm run dev
```
> **Note**
> Do this in your terminal, in the folder where you want to save the project.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/featureName`)
3. Commit your Changes (`git commit -m 'Add some featureName'`)
4. Push to the Branch (`git push origin feature/featureName`)
5. Open a Pull Request
> **Warning**
> Please, follow my commit patterns. I use this [Conventional Commits](https://github.com/iuricode/padroes-de-commits) and these [GitMoji](https://gitmoji.dev/) (priority these emojis over the Conventional Commits) for all commit.
## Contact
## Acknowledgments
- [Rocketseat - React course](https://www.rocketseat.com.br/formacao/react) - This challenge was developed by Rocketseat.
- [Iuricode](https://github.com/iuricode) - I have used his Commit Patterns and inspired in your Readme Template.