create-rust-app

The qsync crate provides a macro-based system to automatically generate React Query hooks for your Rust services. It works by inspecting your service methods and generating corresponding TypeScript hooks for use in your frontend.

Key Requirements & Assumptions:

• React Query Version: Last tested with "react-query": "^3.39.3".
• Data Format: Endpoints must return JSON compatible with fetch(..).json().
• Routing: The directory structure of your Rust project determines the generated API paths.
• Macro Ordering: When using web frameworks like actix_web, you must place the #[qsync] attribute above the framework's routing attribute (e.g., #[get("..")]). This is because Rust evaluates macros from the outermost to the innermost, and qsync needs to wrap the method before the framework defines the route.

The application handles environment variables differently depending on the environment:

• Development: The application reads from a .env file. You can use .env.example as a template for your local configuration.
• Production: Environment variables are sourced directly from the system environment.

Use cargo fullstack to run the entire application in development mode with file watching enabled. The app will be available at http://localhost:3000.

• Frontend: Changes appear instantly.
• Backend: Changes require recompilation (handled by cargo-watch).

If you want to run the app in development mode without watching for file changes, use cargo run instead.

Debugging Production Builds: To test/debug production-specific code paths while in development, set debug-assertions = true for [profile.dev] in your Cargo.toml.

To use create-rust-app, you must first install the CLI tool via cargo.

Prerequisites

• Rust
• diesel_cli
  • For SQLite users: If you want to avoid dynamic linking with your system's libsqlite3, use: cargo install diesel_cli --no-default-features --features sqlite-bundled.

cargo install create-rust-app_cli

To use projects bootstrapped with Create Rust App, ensure you have the following installed:

• Stable Rust: The standard Rust toolchain.
• Diesel CLI: Required for database management. Install based on your database type:
  • Postgres: cargo install diesel_cli --no-default-features --features postgres
  • SQLite: cargo install diesel_cli --no-default-features --features sqlite-bundled
• cargo-watch: Required for continuous compilation and the cargo fullstack command.
  • cargo install cargo-watch

To add new resources (like database models or API endpoints) to an existing project, navigate to your project directory and run the create-rust-app command again to enter the interactive code-generation menu.

cd ./my-todo-app
create-rust-app

Once your project is created, you can run both the Rust backend and the ViteJS frontend simultaneously using a single command.

cargo fullstack

You can scaffold a new modern Rust + React web application by running the create-rust-app command followed by your desired project name. The CLI will guide you through selecting a backend framework, plugins, and other configurations.

create-rust-app my-todo-app

Generate static content for the website using yarn build. The resulting static files will be located in the build directory and can be hosted using any static content hosting service.

$ yarn build

Start a local development server using yarn start. This command will automatically open a browser window, and most changes will be reflected live via hot reloading without requiring a server restart.

$ yarn start

The Tasks plugin (supporting actix-web and postgresql) uses the fang crate for background job processing.

1. Add a task to the queue using create_rust_app::tasks::queue().
2. Run the task worker using the following command:

cargo run --bin tasks

To start a new project using Create Rust App, first install the CLI tool using cargo install. Once installed, you can scaffold a new application by running the create-rust-app command followed by your desired project name.

cargo install create-rust-app_cli

create-rust-app my-app