faire-todo-app

KO | EN

gitlite — search

#javascript #react #ai #golang #go #deep-learning #docker #macos #nodejs #awesome-list #vue #pytorch #mcp #openai

(★ 9)

A multiplatform, opensource and offline first todo app

faire-todo-app Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
<a href="https://github.com/charlesschaefer/faire-todo-app/">
  <img src="https://raw.githubusercontent.com/charlesschaefer/faire-todo-app/refs/heads/main/src/assets/logo.svg" alt="Faire Logo" width="170">
</a>
</p>
<h1 align="center"><b>Faire Todo App</b></h1>

Faire is an offline-first OpenSource multiplatform todo app, created with Tauri and Angular. It stores the data using the IndexedDb of your platform's embeded web browser. 
Besides being offline-first, it offers two ways to syncrhonize your tasks between your devices, one offline, using only your local network, and the other online, using your Google Account (Google OAuth authentication) to store your tasks in a server and synchronize them between your logged in devices.

When using the offline (local network only) synchronization, you can connect two devices on the same network and, after they discover each other, you can send the data from one to another.

Alternativelly you can sign in using Google OAuth. Thus, your tasks' data will be synchronized between signed in devices using Supabase's servers.

## What does Faire means?

Faire is the french infinitive verb equivalent to "to do".

# Features

- [x] Tasks (of course)
- [x] Works 100% offline.
- [x] Projects, where you can group tasks by project or themes.
- [x] An inbox area, where you can register all tasks before moving to projects or prioritizing
- [x] Due date and Due time for the tasks
- [x] View of tasks for today
- [x] View of upcoming tasks
- [x] Search tasks
- [x] View all tasks
- [x] Allow undoing when deleting a task or marking it as complete.
- [x] Manual task ordering, for prioritization
- [x] Notifications of tasks reaching their due time (Windows and Linux only)
- [x] Subtasks
- [x] Recurring tasks (daily, weekly, monthly, yearly and week days)
- [x] Synchronization of data between devices connected in the same network
- [x] Fill the due date and due time based on dates typed in the task title (i.e.: "Do this today" sets the due date for today automatically). Both English and Brazilian Portuguese.
- [x] Google OAuth sign in option
- [x] Devices synchronization using Supabase's servers for signed in users
- [x] Update due tasks' date for "today"
- [x] Tasks with Attachments
- [ ] Swipe to complete/delete
- [ ] Add color to each project and some mark of the project tasks
- [ ] Tags for tasks
- [ ] A calendar view of the tasks
- [ ] A time tracker to track each task

# Building

```
npm install
npm run tauri build # for windows, linux and macOS
# or run the following for android:
npm run tauri android init
npm run tauri android build
```

Check [Tauri Dependencies](https://v2.tauri.app/start/prerequisites/) to know what to install before building. And check [Android Code Signing](https://v2.tauri.app/distribute/signing/android/) to know how to set up keys to sign your APK.

## Building flatpak packages

Our build process uses the same approach from Tauri documentation - we download the latest .deb package from github and use it's files to build the package.

In order to build flatpak packages, you need to install `flatpak` and `flatpak-builder`:
```bash
apt install flatpak flatpak-builder
```

Then, before building you need to add a git submodule to be able to build libayatana-appindicator, that is used by tray-icon:
```bash
git submodule add https://github.com/flathub/shared-modules.git
```

Now you can build and run the package:
```bash
flatpak-builder --force-clean  build-dir net.charlesschaefer.fairetodoapp.yml
flatpak-builder --run build-dir/ net.charlesschaefer.fairetodoapp.yml faire-todo-app
```

Now you can test the app installation:
```bash
# creates a repository 'local-flatpak-repo'
mkdir -p local-flatpak-repo
flatpak build-export local-flatpak-repo build-dir
# adds 'repo' directory created previously as a repository named 'faire-local'
flatpak remote-add --user --if-not-exists --no-gpg-verify faire-local local-flatpak-repo
# removes the gpg verification in case the repository was pre-existing
flatpak remote-modify --user faire-local --no-gpg-verify
# installs the package
flatpak install faire-local net.charlesschaefer.fairetodoapp.yml
```

**Attention**: after building, remove the submodule directory:
```bash
git submodule deinit -f shared-modules
rm shared-modules/ -Rf
```

# Install android dependencies

```
mkdir ~/.android/sdk
cd ~/.android/sdk
wget https://dl.google.com/android/repository/commandlinetools-linux-12266719_latest.zip
unzip commandlinetools-linux-12266719_latest.zip
mkdir cmdline-tools/latest
mv cmdline-tools/* cmdline-tools/latest
cd cmdline-tools/latest/
./bin/sdkmanager --licenses
./bin/sdkmanager tools
./bin/sdkmanager platform-tools
./bin/sdkmanager "ndk;27.0.11902837"

# Set environment variables

export ANDROID_HOME=$HOME/.android/sdk
export ANDROID_SDK_ROOT=$HOME/.android/sdk
export NDK_HOME=$HOME/.android/sdk/ndk/27.0.11902837

# Install Rust toolchains
rustup toolchain install stable --target aarch64-linux-android --target armv7-linux-androideabi --target i686-linux-android --target x86_64-linux-android --profile minimal
```

# Developing

```
npm install
npm run tauri dev
# or to test on android emulator or device:
npm run tauri android dev
```

# Supabase and Google OAuth Authentication
In order to be able to make OAuth authentication to work on Android Devices, we needed to implement two Tauri plugins in the project:
- [shell](https://v2.tauri.app/plugin/shell/): Allows us to open an URL outside the app (opens in the user's default browser)
- [deep-linking](https://v2.tauri.app/plugin/deep-linking/): Allows us to associate the App as the one that will be used to open some kind of URLs.
- [single-instance](https://v2.tauri.app/plugin/single-instance/) (only desktop): Helps to avoid opening new app instances when the user clicks a deep-link outside of the app.

By using shell plugin, we can ask the Android system to open supabase's authentication URL in a new browser window, allowing the user to reuse their current Google session, instead of having to log in within the App's webview. Our supabase authentication server was configured to redirect the user to an external URL (in this case, https://charlesschaefer.net/faire-todo-app/* prefixed URLs).

Then, when the authentication is finished, Google redirects the user to something like **$URL/redirect.html#auth_token=....&refresh_token=....**. As Faire is registered as the app that opens this prefixed URLs, the user is automatically redirected to the app, that will receive the URL (including the needed tokens). We can then finish the signin process.

Check the file `src/app/services/auth.service.ts` (methods `signInWithGoogle` and `handleAuthCallback`).

# Download

## Linux
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/faire-todo-app)

Download the best bundle for your distro from our [latest release](https://github.com/charlesschaefer/faire-todo-app/releases).

## Windows

Download the `.exe` or `.msi` installers from our [latest release](https://github.com/charlesschaefer/faire-todo-app/releases).

## MacOS

Download the `.dmg` file from our [latest release](https://github.com/charlesschaefer/faire-todo-app/releases).

## Android

[Faire Todo App](https://play.google.com/store/apps/details?id=com.fairetodoapp) at Google Play Store.

# Developing

## Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) + [Angular Language Service](https://marketplace.visualstudio.com/items?itemName=Angular.ng-template).

faire-todo-app

faire-todo-app Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

faire-todo-app

faire-todo-app Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README