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

• Learn how to navigate the app rapidly with Keyboard Shortcuts.
• Personalize your editor using Theming.