Getting Started

Welcome to the Hibiscus workspace! This guide will help you install, configure, and get started with your study planner and coding environment.

Installation

Prerequisites

• Node.js (v16+)
• Rust (1.70+)
• Ensure you have the Tauri OS prerequisites installed for your specific platform (Windows, macOS, or Linux).

Setup

1. Clone the repository:

   git clone https://github.com/AndyFerns/Hibiscus.git
   cd Hibiscus
   

2. Install frontend dependencies:

   npm install
   

3. Start the development server: You can use the built-in CLI helper script to launch the app:

   node scripts/hibiscus.cjs dev
   

   This command spins up Vite and compiles the Rust backend, opening the native window.

Core Concepts

Hibiscus operates as a local-first editor. It never syncs your personal notes or code to a cloud environment without your explicit action.

When you configure a directory as your workspace, Hibiscus drops a hidden .hibiscus folder there to store:

• workspace.json: Your file tree layouts and pinned sessions.
• calendar.json: Your study planner tasks and events.
• backups/: Rotating timestamped safety backups of your data.

Next Steps

Core Workflow

• Understand the Workbench Layout - IDE-style panel system
• Master the Multi-File Editor for efficient workflow management
• Learn the File Explorer - Navigate and organize your workspace
• Discover the Editor System - Monaco features and markdown preview

Productivity Features

• Schedule with the Calendar & Daily Planner
• Study effectively with Study Tools - Pomodoro, flashcards, stats
• Navigate rapidly with Keyboard Shortcuts
• Explore the Knowledge Graph - Visualize note connections
• Search everything with the Search System

Customization

• Personalize appearance with Theming
• Create custom themes with the Theme Editor
• Master the Status Bar - Quick controls and indicators

Development

• Understand Application Flow - How Hibiscus works
• Review Developer Documentation for technical details