Skip to content

Shūkan Trackr is a free, open-source habit tracking app designed to work offline-first with local data storage. Start tracking your daily habits with ease, no matter what platform you're on!

Notifications You must be signed in to change notification settings

retconned/shukan-trackr

Repository files navigation

🗓️ Shūkan Trackr - 習慣トラッカー

Shūkan Trackr is a free, open-source habit tracking app with local-first, offline support. It's a Progressive Web App (PWA) that works seamlessly across all platforms with one-click installation on phones. Built with React and TypeScript using Vite, this app is designed to help you track your habits!

🌟 Features

  • Free & Open Source - No hidden costs! Built for the community.
  • Local-first with Offline Support - No internet? No problem. Your data is saved locally.
  • Progressive Web App (PWA) - Installable on any platform (mobile or desktop) in just one click!
  • Vite + React + TypeScript - Fast, modern, and flexible tech stack for developers.

📱 One-Click Installation (Mobile)

  1. Open the app in your mobile browser.
  2. Tap the "Install" button or "Add to Home Screen."
  3. Start tracking your habits from your home screen just like a native app!

🚀 Get Started Locally

To install and run Shūkan Trackr on your machine for development or testing:

Prerequisites

Installation

  1. Clone the repo:

    git clone /~https://github.com/yourusername/shukan-trackr.git
    cd shukan-trackr
  2. Install dependencies:

    pnpm install
  3. Start the development server:

    pnpm run dev
  4. Build for production:

    pnpm run build

Additional Commands

  • Preview the production build:
    pnpm run preview
  • Run tests:
    pnpm test

🏗️ Contributing

Contributions are welcome! If you have ideas for new features, bug fixes, or improvements, feel free to open a pull request or submit an issue.

📄 License

This project is licensed under the MIT License.


Enjoy using Shūkan Trackr and happy habit tracking! 💪😊

About

Shūkan Trackr is a free, open-source habit tracking app designed to work offline-first with local data storage. Start tracking your daily habits with ease, no matter what platform you're on!

Topics

Resources

Stars

Watchers

Forks