tasknote/README.md

TaskNote

[]

📋 Table of Contents

• About the Project
• Features
• Tech Stack
• Installation
• Usage
• Contributing
• License
• Contact

📝 About the Project

TaskNote was created to make our lives easier. In a nutshell, you can manage your TODOs and your Notes.

A key feature is that you can #tag a todo or note and search or filter later.

TODO: add GIF or screenshot of the app

✨ Features

• Create and manage TODO items
• Create and manage Notes
• Tag TODOs and Notes

🚀 Tech Stack

• Frontend: React, Typescript, Vite, Vitest, Code Coverage
• Backend: Node.js
• Database: PostgreSQL
• Other Technologies: Docker, Docker Compose, Caddy

🛠 Installation

1. Clone the repo

   git clone https://github.com/ricardo-campos-org/react-typescript-todolist
   

2. Install NPM packages

   npm install
   

3. 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:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing feature')
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.

📞 Contact

Ricardo Campos on X - @RicardoMpcInc