This is an example of serving static files with Actix Web and Shuttle.
``` ```toml Cargo.toml theme={null} [package] name = "static-files" version = "0.1.0" edition = "2021" [dependencies] actix-files = "0.6.2" actix-web = "4.3.1" shuttle-actix-web = "0.57.0" shuttle-runtime = "0.57.0" tokio = "1.26.0" ``` ```toml Shuttle.toml theme={null} [build] assets = [ "assets/*", ] ```WebSocket example
When you connect you will be notified of the Shuttle API status and the amount of connected users every 15 seconds.
You can also send a message to the server and you will get back the echo.
Status:
disconnected
```
```toml Cargo.toml theme={null}
[package]
name = "websocket-actorless"
version = "0.1.0"
edition = "2021"
publish = false
[dependencies]
actix-files = "0.6.2"
actix-web = "4.3.1"
actix-ws = "0.2.5"
chrono = { version = "0.4.23", features = ["serde"] }
futures = "0.3"
reqwest = "0.11"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
shuttle-actix-web = "0.57.0"
shuttle-runtime = "0.57.0"
tokio = { version = "1", features = ["rt-multi-thread", "sync"] }
tracing = "0.1"
```
```toml Shuttle.toml theme={null}
[build]
assets = [
"static/*",
]
```
This is an example of serving static files with Axum and Shuttle.
``` ```toml Cargo.toml theme={null} [package] name = "static-files" version = "0.1.0" edition = "2021" publish = false [dependencies] axum = "0.8" shuttle-axum = "0.57.0" shuttle-runtime = "0.57.0" tokio = "1.28.2" tower-http = { version = "0.6", features = ["fs"] } ``` ```toml Shuttle.toml theme={null} [build] assets = [ "assets", ] ```
Current API status
Last check time
Clients watching
This is an example of serving static files with Rocket and Shuttle.
Click here to go to the About page ``` ```html assets/about.html theme={null}This is the About page.
``` ```toml Cargo.toml theme={null} [package] name = "static-files" version = "0.1.0" edition = "2021" publish = false [dependencies] rocket = "0.5.0" shuttle-rocket = "0.57.0" shuttle-runtime = "0.57.0" tokio = "1.26.0" ``` ```toml Shuttle.toml theme={null} [build] assets = [ "assets", ] ```**Windows**: `%APPDATA%\Claude\claude_desktop_config.json` | ## You're all set! π Your AI coding assistant now has direct access to Shuttle's knowledge base and tooling. Let's see it in action! ## How to use? ### Prompting Best Practices To get the most out of the **Shuttle MCP server**, end your prompts with `Use the Shuttle MCP server`, this makes sure that the AI agent always references the most up-to-date Shuttle documentation and examples when helping you with your code. It also makes the AI agent more likely to use the Shuttle MCP server for deployments, logs, project, status, etc. ```txt theme={null} Build a Simple Todo App with Axum and then deploy it to Shuttle. Use the Shuttle MCP server. ``` ### Add AI Assistant Rules (Recommended) Create AI agent rules in your project to establish consistent coding practices. Choose the appropriate file based on your AI coding assistant: * **Cursor**: `.cursor/rules/shuttle.mdc` * **Windsurf**: `.windsurf/rules/shuttle.md` * **Claude Code**: `CLAUDE.md` ```markdown theme={null} # Shuttle Rules - Always use the Shuttle MCP to get the latest docs and examples - Whenever needed, use the Shuttle MCP server for deployments, logs, project, status, etc. ``` #### For Cursor Users: Enable "Always Apply" When adding rules in Cursor, make sure to select "Always Apply" to ensure the rule is applied to all AI chats automatically.
Hello world
{% endblock content %} ``` Now we have our template, we need to register it under a Tera instance. Tera has a nice [filesystem-based registration system](https://docs.rs/tera/1.16.0/tera/struct.Tera.html#method.new), but we will use the [`include_str!`](https://doc.rust-lang.org/std/macro.include_str.html) macro so that the content is in the binary. This way we don't have to deal with the complexities of a filesystem at runtime. We register both templates so that the `index` page knows about `base.html`. ```rust theme={null} let mut tera = Tera::default(); tera.add_raw_templates(vec![ ("base.html", include_str!("../templates/base.html")), ("index", include_str!("../templates/index.html")), ]) .unwrap(); ``` We add it via an [Extension](https://docs.rs/axum/latest/axum/struct.Extension.html)(wrapped in `Arc` so that extension cloning does not deep clone all the templates) ```rust theme={null} #[shuttle_runtime::main] async fn axum() -> shuttle_axum::ShuttleAxum { let mut tera = Tera::default(); tera.add_raw_templates(vec![ ("base.html", include_str!("../templates/base.html")), ("index", include_str!("../templates/index.html")), ]) .unwrap(); let router = Router::new() .route("/hello", get(hello_world)) .layer(Extension(Arc::new(tera))); Ok(router.into()) } ``` ### Rendering views Now we have created our Tera instance we want it to be accessible to our get methods. To do this in Axum, we add the extension as a parameter to our function. In Axum, an [Extension](https://docs.rs/axum/latest/axum/struct.Extension.html) is a unit struct. Rather than dealing with .0 to access fields, we use destructuring in the parameter (if you thought that syntax looks weird). ```rust theme={null} async fn index( Extension(templates): ExtensionHello world
{% if username %}Logged in: {{ username }}
{% endif %} {% endblock content %} ``` Using our middleware in requests is easy in Axum by including a reference to it in the parameters. We then add the username to the context for it to be rendered on the page. ```rust theme={null} async fn index( Extension(current_user): ExtensionHi! Welcome to Rustcord. Enjoy your stay!