Skip to content

Repository files navigation

Twill

Twill is a private, local-first study application for concept-based retrieval practice and spaced repetition. It stores the complete library and review history on the learner's device, uses FSRS for scheduling, and does not require an account or hosted server.

The application is built with Tauri 2, Vue 3, JavaScript, and Rust. Linux is the current desktop development target; Android, iPhone, and iPad support is planned but not integrated yet.

Prerequisites

Install

Clone the repository and install the JavaScript dependencies:

git clone https://github.com/autoboxer/twill.git
cd twill
npm install

Run

Launch the native desktop application in development mode:

npm run tauri dev

Tauri starts the Vite development server automatically and opens the application window.

To run only the browser-based frontend:

npm run dev

Browser mode is useful for frontend work, but native persistence and other Tauri commands are unavailable outside the desktop application.

Test and check

Run the Rust test suite:

npm test

Run the JavaScript linter, frontend production build, and Rust compiler checks:

npm run check

Build

Build the native application and packages supported by the current platform:

npm run tauri build

Build only the frontend assets:

npm run build

About

An offline-first repetitive learning app

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages