Taskwarrior Mobile App
A cross-platform Flutter client for Taskwarrior.
---
## Table of Contents
- [About](#about)
- [Screenshots](#screenshots)
- [Built With](#built-with)
- [Setup](#setup)
- [Syncing](#syncing)
- [TaskChampion (recommended)](#taskchampion-recommended)
- [Legacy TaskServer](#legacy-taskserver)
- [Contributing](#contributing)
- [Google Summer of Code](#google-summer-of-code)
- [Community](#community)
- [Contributors](#contributors)
- [Maintainers](#maintainers)
- [License](#license)
---
## About
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](https://taskwarrior.org/download/).
This project brings that workflow to mobile and desktop: manage your tasks, filter them, and keep them in sync across all your devices.
## Screenshots
## Built With
- [Dart](https://dart.dev/)
- [Flutter](https://flutter.dev/)
- [Rust](https://www.rust-lang.org/): TaskChampion storage/sync via [`flutter_rust_bridge`](https://cjycode.com/flutter_rust_bridge/)
- [GetX](https://pub.dev/packages/get): state management and routing
## Setup
Full local setup instructions (FVM, the pinned Flutter SDK, Android/iOS,
optional Rust, and which files not to touch) live in **[SETUP.md](SETUP.md)**.
Quick start:
```bash
# 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 production
```
If you are not using FVM, run the same commands with `flutter` and make sure
your SDK matches the version in `.fvmrc`. See [SETUP.md](SETUP.md) for details.
## Syncing
The app supports two sync backends. TaskChampion is the modern one and is recommended for new setups.
### TaskChampion (recommended)
The app syncs through TaskChampion. You can use [WingTask](https://app.wingtask.com/) 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.
### Legacy TaskServer
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](https://gothenburgbitfactory.github.io/taskserver-setup/)
- Video tutorial: [Watch on YouTube](https://www.youtube.com/watch?v=6Ci_JyvVIaI&ab_channel=MetaphysicsComputing)
- Cloud hosting: run it on Azure or any other cloud provider for access from anywhere.
- Docker: [ogarcia/docker-taskd](https://github.com/ogarcia/docker-taskd)
## Contributing
Contributions of every kind are welcome: features, fixes, refactors, performance work, and documentation.
- Read **[CONTRIBUTING.md](CONTRIBUTING.md)** for the full workflow, including how to raise an issue and open a pull request.
- Read **[SETUP.md](SETUP.md)** to get the project running locally.
- Maintainers are listed in **[AUTHORS.md](AUTHORS.md)**.
- Found a bug? Open an [issue](https://github.com/CCExtractor/taskwarrior-flutter/issues/new).
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.
## Google Summer of Code
This project is supported by [Google Summer of Code](https://summerofcode.withgoogle.com/). It started in 2022 as a [GSoC 2022 project](https://summerofcode.withgoogle.com/programs/2022/projects/8pYfxjXv) under the [CCExtractor Development](https://ccextractor.org/) 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](https://ccextractor.org/public/gsoc/) for current project ideas and application guidance.
## Community
Join the CCExtractor community on Zulip for questions, discussions, and contributions:
[](https://ccextractor.org/public/general/support/)
## Contributors
## Maintainers
- [Shubham Ingale](https://github.com/SGI-CAPP-AT2) ([@SGI-CAPP-AT2](https://github.com/SGI-CAPP-AT2))
- [Chinmay Chaudhari](https://github.com/BrawlerXull) ([@BrawlerXull](https://github.com/BrawlerXull))
- [Carlos Fernandez Sanz](https://github.com/cfsmp3) ([@cfsmp3](https://github.com/cfsmp3))
- [Mabud Alam](https://github.com/MabudAlam401) ([@MabudAlam401](https://github.com/MabudAlam401))
## License
Distributed under the GNU General Public License v3.0. See [`LICENSE`](LICENSE) for the full text.