Getting Started with RustF
Welcome to RustF! This guide will help you get up and running with the framework in minutes.
What You’ll Learn
In this section, you’ll learn:
- How to install RustF and its dependencies
- How to create your first “Hello World” application
- How to understand the project structure
- Basic development workflow
Prerequisites
Before you begin, make sure you have:
- Rust 1.70+ installed (rustup.rs)
- Cargo (comes with Rust)
- Basic familiarity with Rust syntax
- A text editor or IDE (VS Code, RustRover, etc.)
Quick Start (3 Steps)
The fastest way to get started:
# 0. Install the CLI (one time)
cargo install rustf-cli
# 1. Create a new project using the CLI
rustf-cli new project my-app
# 2. Navigate to your project
cd my-app
# 3. Run the server
cargo run
That’s it! Your server will be running at http://127.0.0.1:8000.
Want a prebuilt binary instead of compiling the CLI? Use
cargo binstall rustf-cli— see Installation for all options.
What’s Next?
- Installation - Detailed installation instructions and setup
- Hello World - Build your first application step-by-step
- Project Structure - Understand how RustF projects are organized
- CLI - Common project, generation, analysis, and schema commands
Need Help?
- Check the Core Guides for detailed framework documentation
- Review Examples for practical tutorials
- Visit our GitHub repository for issues and discussions
Ready to dive in? Let’s start with Installation!