2.5 KiB
Welcome to Rustelo!
Date: {{generation_timestamp}} Author: {{author}} Tags: rustelo, welcome, getting-started Description: Welcome to your new Rustelo implementation! This guide will help you get started.
Welcome to {{project_name}}, your new Rustelo-powered web application! 🦀✨
What is Rustelo?
Rustelo is a modern Rust web framework that provides:
- 🚀 Fast Development - Hot reload, efficient builds, and great DX
- 🏗️ Framework as Dependency - No forks, clean updates, easy maintenance
- 🎨 Modern UI - Built-in UnoCSS, components, and responsive design
- 📝 Content Management - Markdown support, static generation, SEO
- 🔐 Authentication - Built-in auth system with multiple providers
- 📦 Asset Management - Smart asset resolution and optimization
Getting Started
Your new implementation is ready to go! Here are your next steps:
1. Start Development Server
just dev
This will start your application at http://localhost:3030 with hot reload enabled.
2. Explore the Structure
{{project_name}}/
├── src/ # Your Rust code
├── content/ # Content files (this blog!)
├── public/ # Static assets
├── justfile # Development tasks
└── rustelo-deps.toml # Framework configuration
3. Create Your First Page
Add a new markdown file to content/pages/:
# My Custom Page
This is my custom content!
4. Customize Styling
Edit unocss.config.ts to customize your design system, or add styles to public/styles/custom.css.
5. Add Components
Create new Leptos components in src/components/ and use them in your layouts.
Framework Updates
Your implementation stays up-to-date with the framework:
# Check for updates
just update-framework
# Apply updates safely
just update
The framework will never overwrite your custom code - only configuration files are updated, and you're always asked first.
Getting Help
What's Next?
- Customize your
content/menu.tomlto add navigation - Add authentication with
cargo rustelo features enable auth oauth2 - Set up analytics with
cargo rustelo features enable analytics tracking - Deploy to production with
just prepare-deploy
Happy building! 🚀