get-started.md

Developing Carpe with Tauri and Svelte

Carpe leverages the power of Tauri for building secure, lightweight desktop applications and Svelte for creating efficient, reactive web interfaces. The project template is based on: https://github.com/jbarszczewski/tauri-svelte-template.

Prerequisites

Before you begin, ensure you have the following dependencies installed:

Required Software

• Node.js: Version 16 or higher - Download from nodejs.org
• Yarn: Package manager - Install via npm: npm install -g yarn
• Rust: Programming language toolchain - Install from rustup.rs

Environment Setup

• General Tauri setup: Follow the official Tauri setup guide
• Windows users: See our specific Windows development environment setup guide

Getting Started

1. Install Rust Dependencies

Navigate to the Tauri source directory and build the Rust backend:

cd src-tauri/
cargo build

2. Install JavaScript Dependencies

Return to the project root and install frontend dependencies:

cd ..
yarn

3. Start Development Server

Launch the development environment:

yarn dev

Note: Closing the app window will exit development/debug mode.

Building for Production

To compile and package Carpe for distribution:

yarn build

This command generates:

• Optimized application builds
• Standalone executables
• Platform-specific installers

All build artifacts are placed in the src-tauri/target/release directory.

Additional Resources

• Tauri: Official Tauri project website with comprehensive documentation
• Svelte: Svelte framework home with guides, tutorials, and API documentation
• Sveltestrap: Bootstrap 4 components for Svelte, enabling rapid responsive UI development