diff options
Diffstat (limited to '')
| -rw-r--r-- | .github/workflows/go-release.yml | 2 | ||||
| -rw-r--r-- | README.md | 32 |
2 files changed, 10 insertions, 24 deletions
diff --git a/.github/workflows/go-release.yml b/.github/workflows/go-release.yml index ff14aeb..2b4047b 100644 --- a/.github/workflows/go-release.yml +++ b/.github/workflows/go-release.yml @@ -31,7 +31,7 @@ jobs: - name: Build Frontend run: | cd frontend-code - npm run build + npm run build --mode selfhosted - name: Copy Frontend run: | @@ -1,24 +1,17 @@  +## What is Donetick +An open-source, user-friendly app for managing tasks and chores, featuring customizable options to help you and others stay organized - -## Donetick service -The Donetick service is the backend of the Donetick project. It handles all the data processing, storage, schedulers, and communication with the frontend. - -## 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 +## Features Highlights - 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. +- Build with sharing in mind: you give people access to you group and you can assign each other tasks. only those assigned to task or chore can see it +- Assignee Assignment: Assign tasks to specific individuals with ability rotate them automatically using customizable strategies like randomly, least completed,etc.. +- Recurring Tasks: Schedule tasks to repeat daily, weekly, monthly, or yearly or something to trigger on specific day of month or day of the week. if you are not sure you can have adaptive recurring task where it does figure it out base on historical completion - Progress Tracking: Track the completion status of tasks and view historical data. +- API Integration -## Installation +## Development Environment 1. Clone the repository: 2. Navigate to the project directory: `cd donetick` 3. Download dependency `go mod download` @@ -32,15 +25,8 @@ Contributions are welcome! If you would like to contribute to Donetick, please f 4. Push to the branch: `git push origin feature/your-feature-name` 5. Submit a pull request -## Need Help: -As a project built while learning Golang, Donetick has evolved organically, and some areas could benefit from refactoring or optimization. I'm particularly interested in contributions that help standardize code patterns, improve performance, or enhance the overall user experience or adding new features! - -## 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 +This project is licensed under the License. See the [LICENSE](LICENSE) file for more details. I might consider changing it later to something else |