Skip to content

Holochain (Rust/TypeScript React) multi-platform Tauri app that helps you track your plans and habits

Notifications You must be signed in to change notification settings

HabFract/planitt

Repository files navigation

🪐 Planitt - your visual, local-first, p2p behavioural planner! ⭐

planitt-transp

Planitt is an innovative habit tracking application that empowers users to create and manage goals and habits through a fractal structure. Built on Holochain, it ensures complete control over privacy and data sovereignty.

🌟 Features

  • Fractal Structure: Create a never-ending fractal of goals and habits.
  • Dynamic Visualizations: Visualize progress with intuitive data visualizations.
  • Data Sovereignty: Maintain full control over your data with Holochain's encryption.
  • Peer-to-Peer Sharing (ON ROADMAP): Share and trade visualizations within a secure network.
  • Private Channels (ON ROADMAP): Collaborate with others for accountability and mentorship.

Join us in the journey of self-improvement and achievement with Planitt, your companion for consistent progress.

🚀 Getting Started

Prerequisites

  • Nix: Install using the command:
    bash <(curl https://holochain.github.io/holochain/setup.sh)
  • pnpm: Ensure pnpm is installed globally.

Development Environment Setup

  1. Enter Development Shell:

    nix develop
  2. Install Dependencies:

    pnpm i
  3. Build Design System:

    pnpm run --dir design-system build
  4. Configure Environment:

    • Rename example.env to .env and adjust port numbers as needed.
  5. Start Development Server:

    pnpm run dev
  6. Access Application:

GraphQL Intellisense

  1. Install VSCode Extension: 'GraphQL for VSCode'
  2. Install Watchman: Watchman Installation Guide

Check the 'GraphQL - monorepo' output tab in your console for errors.

🧪 Running Tests

  • In a Nix shell, execute:
    pnpm test

🏭 Production Setup

  1. Open Nix Shell:

    nix develop .#androidDev
  2. Build Frontend:

    pnpm run build:frontend
  3. Start Application:

    pnpm start
  4. Build for Android

pnpm run tauri android build

📄 License

This project is licensed under the Apache License. See the [LICENSE](https://github.com./HabFract/planitt/blob/main/ui/src/LICENSE) file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

🔗 Links