Skip to content

About

step 2 tracker app

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

549 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TimeFolio

TimeFolio is a free, open-source, local-first study app for macOS. It is a React + TypeScript + Vite frontend with a Tauri desktop shell and native SQLite persistence.

Distribution

What It Does

  • Today dashboard for active work, reminders, and progress
  • Practice test logging with score trends, weak/strong topic patterns, and follow-up actions
  • Weak topics tracking with status, priority, and remediation history
  • Analytics across tasks, tests, and topic trends
  • Native desktop notifications for reminders on Mac
  • Signed updater support for release builds

Install And Run

1. Install dependencies

Run npm install.

2. Run the web app in development

Run npm run dev.

3. Run the desktop app in development

Run npm run tauri:dev.

4. Build the macOS desktop app

Run npm run tauri:build.

The macOS app bundle is produced under src-tauri/target/release/bundle/macos/. If you build the DMG target, it is produced alongside the updater bundle.

Required Environment

  • macOS for the desktop app features
  • Node.js 20+ and npm
  • Rust toolchain for Tauri builds
  • Xcode command line tools on macOS

If Tauri is missing system dependencies, install the usual macOS build tools first:

xcode-select --install

Where Data Lives

The app is local-first. All state is stored on the Mac in the app data directory for the bundle identifier:

~/Library/Application Support/com.paul.step2ckcommandcenter/

The SQLite database used by the app lives under that folder. Deleting the app bundle does not delete data; deleting the app data folder does.

Notifications

Desktop reminders use the native macOS notification plugin.

  • The first reminder action may prompt for notification permission.
  • If permission is blocked, the app opens macOS Notification settings.
  • To test reminders, set a reminder on a task and wait until it becomes due, or use the test alert button in Settings.

If alerts do not appear:

  1. Open System Settings.
  2. Go to Notifications.
  3. Find TimeFolio.
  4. Enable notifications and alert style.

Updater

Release builds check for signed updates on launch.

Installed builds default to the GitHub Releases feed for this repository:

https://github.com/PaulElon/Step2Tracker/releases/latest/download/latest.json

You can still override that at runtime with either of these environment variables:

  • STEP2_UPDATER_ENDPOINT
  • STEP2_UPDATER_ENDPOINTS

Build release artifacts locally with the updater signing key:

TAURI_SIGNING_PRIVATE_KEY="$(cat ~/.tauri/step2-command-center.key)" npm run tauri:build

The matching public key is embedded in:

  • src-tauri/tauri.conf.json
  • src-tauri/src/updater.rs

Automatic Releases From main

The repository includes .github/workflows/release.yml.

Every push to main must be followed by a signed Tauri release. The workflow runs automatically on every main push and publishes a signed Apple Silicon macOS release, Windows installer, and latest.json updater manifest that Tauri expects.

Desktop Development Guardrail

  • Do not report desktop main work as complete until the release is published.
  • Installed apps do not auto-update from main alone. They only auto-update when a new release with a higher app version is published to GitHub Releases. A commit to main without a release means no change reaches installed users.
  • Monitor the GitHub Actions workflow after pushing to main. Confirm the Release Desktop App workflow succeeds and check GitHub Releases for the new app-v* tag and artifacts.
  • If you need to prevent automatic release (exceptional cases only), either pause the workflow before pushing or roll back the commit.
  • If the user explicitly says "no release," state that installed users will not receive the changes.

Release Workflow Details

The workflow automatically:

  1. Computes a CI version from package.json/tauri.conf.json major.minor + GitHub run number as patch.
  2. Tags the commit as app-vX.Y.Z and stamps versions across package.json, src-tauri/tauri.conf.json, and src-tauri/Cargo.toml.
  3. Builds and publishes signed macOS (Apple Silicon) and Windows (NSIS) installers.
  4. Uploads latest.json for the Tauri updater and a direct-download DMG for manual install.

Required GitHub repository secrets:

  • TAURI_SIGNING_PRIVATE_KEY
  • TAURI_SIGNING_PRIVATE_KEY_PASSWORD

Use TAURI_SIGNING_PRIVATE_KEY_PASSWORD only if your updater key is encrypted. An empty value is acceptable if the key has no password.

Important constraints:

  • Auto-update only works for installed release builds, not npm run tauri:dev.
  • Tauri only installs an update when the published version is newer than the installed version.
  • The workflow stamps a unique CI version per main push before building release artifacts.
  • The repository or release artifact host must be publicly reachable by the installed app, because the app cannot authenticate to private GitHub release assets.

Standard Verification

Run these checks before shipping:

  • npm run typecheck
  • npm run lint
  • npm run build
  • cargo check --manifest-path src-tauri/Cargo.toml

Notes

  • The app uses native persistence, so browser storage clearing does not reset data.
  • Practice test data, reminders, weak topics, planner tasks, settings, and backups are persisted together in the local database.
  • If you need a full reset, remove the app data directory only after backing it up.
  • Deleting /Applications/TimeFolio.app removes the app bundle only. It does not remove user data.
  • Some technical identifiers keep legacy Step 2 naming for compatibility, including the app data path, updater environment variables, signing key path, and repository URL.

About

step 2 tracker app

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages