A cross-platform Flutter client for Taskwarrior.
- About
- Screenshots
- Built With
- Setup
- Syncing
- Contributing
- Google Summer of Code
- Community
- Contributors
- Maintainers
- License
Taskwarrior is free and open-source software that manages your TODO list from the command line. It is flexible, fast, and unobtrusive. The CLI tool and its documentation live at taskwarrior.org.
This project brings that workflow to mobile and desktop: manage your tasks, filter them, and keep them in sync across all your devices.
- Dart
- Flutter
- Rust: TaskChampion storage/sync via
flutter_rust_bridge - GetX: state management and routing
Full local setup instructions (FVM, the pinned Flutter SDK, Android/iOS, optional Rust, and which files not to touch) live in SETUP.md.
Quick start:
# Clone
git clone https://github.com/CCExtractor/taskwarrior-flutter.git
cd taskwarrior-flutter
# Install the pinned SDK and dependencies (FVM)
fvm install
fvm flutter pub get
# Check your setup
fvm flutter doctor
# Run (the Android flavor is required)
fvm flutter run --flavor productionIf you are not using FVM, run the same commands with flutter and make sure
your SDK matches the version in .fvmrc. See SETUP.md for details.
The app supports two sync backends. TaskChampion is the modern one and is recommended for new setups.
The app syncs through TaskChampion. You can use WingTask as a hosted TaskChampion sync server to keep your tasks in sync across devices. Point the app at your server URL, client ID, and encryption secret.
TaskServer lets you share tasks across clients and devices, and keeps an automatic backup of your data.
Self-hosted TaskServer
- Official setup guide: taskserver-setup
- Video tutorial: Watch on YouTube
- Cloud hosting: run it on Azure or any other cloud provider for access from anywhere.
- Docker: ogarcia/docker-taskd
Contributions of every kind are welcome: features, fixes, refactors, performance work, and documentation.
- Read CONTRIBUTING.md for the full workflow, including how to raise an issue and open a pull request.
- Read SETUP.md to get the project running locally.
- Maintainers are listed in AUTHORS.md.
- Found a bug? Open an issue.
We follow an issue-first policy: please open an issue and wait for a maintainer to validate and assign it before starting work on a pull request.
This project is supported by Google Summer of Code. It started in 2022 as a GSoC 2022 project under the CCExtractor Development umbrella organization, and has taken part in several GSoC editions since. Other than this generous sponsorship, the project has no relationship with Google.
We welcome future GSoC contributors. See the CCExtractor GSoC ideas page for current project ideas and application guidance.
Join the CCExtractor community on Zulip for questions, discussions, and contributions:
- Shubham Ingale (@SGI-CAPP-AT2)
- Chinmay Chaudhari (@BrawlerXull)
- Carlos Fernandez Sanz (@cfsmp3)
- Mabud Alam (@MabudAlam401)
Distributed under the GNU General Public License v3.0. See LICENSE for the full text.