Prerequisites
Before building En Croissant, ensure you have the required tools installed.Required Software
Install Rust
Install Node.js
Install Node.js 18 or later from nodejs.org
Install pnpm
En Croissant uses pnpm as the package manager. Install it globally:Or follow the pnpm installation guide for other methods.Verify installation:
Install Tauri Dependencies
Tauri requires platform-specific dependencies. Follow the Tauri Prerequisites Guide for your operating system.Linux:macOS:Windows:
- Install Microsoft Visual Studio C++ Build Tools
- Install WebView2 (usually pre-installed on Windows 11)
Building En Croissant
Install Dependencies
Install all JavaScript dependencies:This will install:
- Frontend dependencies (React, Vite, Mantine, etc.)
- Development tools (TypeScript, Biome, Vitest)
- Tauri CLI
Development Build
To run En Croissant in development mode with hot reloading:This starts:
- Vite development server on port 1420
- Tauri application window
- Hot module replacement for frontend changes
- Automatic Rust recompilation on backend changes
Additional Build Commands
Type Checking
Run TypeScript type checking without building:Testing
Run the test suite:Code Formatting
Format code with Biome:i18n Management
Extract translation strings:Platform-Specific Notes
Linux
AppImage: To create an AppImage bundle:src-tauri/target/release/bundle/appimage/.
Wayland:
If you encounter issues on Wayland, you may need to set:
macOS
Apple Silicon: Building on Apple Silicon (M1/M2) requires no special configuration. Cross-compilation to x86_64 is possible:Windows
MSVC vs GNU: Use the MSVC toolchain (default) for best compatibility:target/ directory to your exclusions.
Troubleshooting
Build Fails with “Cannot find module”
Ensure dependencies are installed:Rust Compilation Errors
Update Rust to the latest stable version:Tauri CLI Not Found
Reinstall dependencies:WebView2 Errors (Windows)
Install or update WebView2 Runtime from Microsoft.Permission Errors (Linux/macOS)
Ensure you have write permissions in the project directory:Development Tips
Faster Builds
Usemold linker (Linux):
lld linker (macOS/Windows):
Add to .cargo/config.toml:
Debug Builds
For development, debug builds are faster to compile:Clearing Build Cache
If you encounter strange build issues, try clearing the cache:Next Steps
Now that you have En Croissant building, check out:- Contributing Guide - Learn how to contribute code
- Technical Architecture - Understand the codebase structure
- GitHub Repository - Browse the source code