aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Mo Tarbin <mhed.t91@gmail.com>2024-06-30 18:55:39 -0400
committerLibravatar Mo Tarbin <mhed.t91@gmail.com>2024-06-30 18:55:39 -0400
commit2657469964e24ffbeb905024532120395f6e797c (patch)
tree2fe9db8a4ecfa92d854ca94f7586d81163c8bd25 /README.md
downloaddonetick-frontend-2657469964e24ffbeb905024532120395f6e797c.tar.gz
donetick-frontend-2657469964e24ffbeb905024532120395f6e797c.tar.bz2
donetick-frontend-2657469964e24ffbeb905024532120395f6e797c.zip
move to Donetick Org, First commit frontend
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e24c032
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+![Logo](assets/image.png)
+
+## Donetick Frontend
+
+The Donetick Frontend is Frontend piece for Donetick written in javascript with React
+
+## What is Donetick?
+
+An open-source, user-friendly app for managing tasks and chores, featuring customizable options to help you and others stay organized.
+
+## Why I made Donetick?
+
+As an avid for open-source, I was eager to create a solution that could benefit the wider community. Donetick started as a personal project to address my own chore management needs, but it has evolved into bigger tool and decide to open source it for anyone seeking a customizable and privacy-focused task management tool
+
+## Features
+
+- Task and Chore Management: Easily create, edit, and manage tasks and chores for yourself or your group.
+- Shared To-Do Lists: Create "Circles" to collaborate on tasks with family or your group
+- Assignee Assignment: Assign tasks to specific individuals or rotate them automatically using customizable strategies.
+- Recurring Tasks: Schedule tasks to repeat daily, weekly, monthly, or yearly, with flexible customization options.
+- Progress Tracking: Track the completion status of tasks and view historical data.
+
+## Installation
+
+1. Clone the repository:
+2. Navigate to the project directory: `cd frontend`
+3. Download dependency `npm install`
+4. Run locally `npm start`
+
+## Contributing
+
+Contributions are welcome! If you would like to contribute to Donetick, please follow these steps:
+
+1. Fork the repository
+2. Create a new branch: `git checkout -b feature/your-feature-name`
+3. Make your changes and commit them: `git commit -m 'Add some feature'`
+4. Push to the branch: `git push origin feature/your-feature-name`
+5. Submit a pull request
+
+## Need Help:
+
+Donetick is a work in progress and has been a fantastic learning experience for me as I've honed my React skills,I'm looking for collaborators to help improve and refine the Donetick. Feel free to open PR or suggest changes.
+
+## Plans :
+
+My goal is to expand Donetick by offering a hosted infrastructure option. This will make it even easier for users to access and utilize Donetick's features without the need for self-hosting.
+
+While maintaining Donetick's commitment to open source, this hosted option will provide a seamless, out-of-the-box experience for those who prefer a managed solution.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. I might consider changing it later to something else