README

Fastest Way to Build & Ship Rust Apps

Get resources and deploy your apps with a few lines of code.


Simple.   Easy.   Joyful.


    Report Bug
    ·
    Request a Feature
    ·
  Join Our Discord
    ·
    Follow us on X
  





⭐ If you find Shuttle interesting, consider starring this repo to help spread the word.


 Features

- One-line Resource Provisioning: Get a database or other resource by adding a single line of code to your main file. No config or yaml files required.
- Rapid Development: It takes 2 minutes from project initialization to a deployed project. It takes seconds to provision a resource, and get it deployed to production.
- First-class support for popular Rust frameworks: Axum, Actix Web, Rocket, and more
- Security: Let us worry about the security & permissions while you focus on writing good code.



 Quick Start

On Linux and macOS, you can use this install script, which will automatically install the correct target for your OS and distro:

sh
curl -sSfL https://www.shuttle.dev/install | bash


On Windows, you can use this install script to do the same:

powershell
iwr "https://www.shuttle.dev/install-win" | iex


After installing, log in with:

sh
shuttle login


To initialize your project, simply write:

bash
shuttle init --template axum hello-world


And to deploy it, write:

bash
cd hello-world
shuttle deploy


And... that's it!

text
Service Name:  hello-world
Deployment ID: 3d08ac34-ad63-41c1-836b-99afdc90af9f
Status:        running
Last Updated:  2022-04-01T08:32:34Z
URI:           https://hello-world.shuttleapp.rs


Feel free to build on top of the generated hello-world boilerplate or take a stab at one of our examples.

For the full documentation, visit our docs.



 Quick Look

Below is a basic "Hello World" application written in Axum:
rust
use axum::{routing::get, Router};

[tokio::main]
async fn main() {
    let app = Router::new().route("/", get(hello_world));

    let listener = tokio::net::TcpListener::bind("127.0.0.1:3000")
        .await
        .unwrap();
    println!("listening on {}", listener.local_addr().unwrap());
    axum::serve(listener, app).await.unwrap();
}

async fn hello_world() - &'static str {
    "Hello, world!"
}


In order to be able to deploy it with a single command, we update the snippet as follows:

rust
use axum::{routing::get, Router};

async fn hello_world() - &'static str {
    "Hello, world!"
}

[shuttle_runtime::main]
async fn main() - shuttle_axum::ShuttleAxum {
    let router = Router::new().route("/", get(hello_world));

    Ok(router.into())
}


Now, with just shuttle deploy, you can see your application live. But let's enhance it further by adding a shared Postgres database:

rust
use axum::{routing::get, Router};

async fn hello_world() - &'static str {
    "Hello, world!"
}

[shuttle_runtime::main]
async fn main(
    [shuttle_shared_db::Postgres] pool: sqlx::PgPool,
) - shuttle_axum::ShuttleAxum {

    pool.execute(include_str!("../schema.sql"))
        .await