1.9 KiB
1.9 KiB
Project Name
📋 Table of Contents
📝 About the Project
Simple TODO app written in React.
TODO: add GIF or screenshot of the app
✨ Features
- Create TODO items
- Edit TODO items
- Mark items as completed
🚀 Tech Stack
- Frontend: React, TypeScript, Vite.
- Backend: Not applicable.
- Database: Not applicable.
- Other Technologies: Docker, Caddy.
🛠 Installation
- Clone the repo
git clone https://github.com/ricardo-campos-org/react-typescript-todolist - Install NPM packages
npm install - Start the development server
npm start
🎮 Usage
Once you're in the home screen, you can click the button to create your first TODO item.
🤝 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.
Steps to Contribute:
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/amazing-feature) - Commit your Changes (
git commit -m 'Add some amazing feature') - Push to the Branch (
git push origin feat/amazing-feature) - Open a Pull Request
📄 License
Distributed under the MIT License. See LICENSE for more information.
📞 Contact
Your Name - @your_twitter
Project Link: GitHub Repository