---

Shuttle

Shuttle is a Rust-native cloud development platform that lets you deploy your Rust apps for free.

Shuttle is built for productivity, reliability and performance:

• Zero-Configuration support for Rust using annotations
• Automatic resource provisioning (databases, caches, subdomains, etc.) via Infrastructure-From-Code
• First-class support for popular Rust frameworks (Actix, Rocket, Axum, Tide, Poem and Tower)
• Support for deploying Discord bots using Serenity
• Scalable hosting (with optional self-hosting)

📖 Check out our documentation to get started quickly: docs.shuttle.rs

🙋‍♂️ If you have any questions, join our Discord server.

⭐ If you find Shuttle interesting, and would like to stay up-to-date, consider starring this repo to help spread the word.

Console Sneak Peek (gif)

The gif above demonstrates the ease of adding/managing resources to your project(s) in our upcoming console. Bear in mind that the ease of adding resources is already there, albeit without the visualization coming from the console.

Getting Started

To run a Shuttle project, you need to install protoc, check out the protoc installation guide in our docs.

The cargo-shuttle CLI can be installed with a pre-built binary or from source with cargo.

Shuttle provides pre-built binaries of the cargo-shuttle CLI with every release for most platforms, they can be found on our GitHub.

Our binaries can also be installed using cargo-binstall, which will automatically install the correct target for your system. To install with cargo-binstall, run:

cargo binstall cargo-shuttle

Although a bit slower, you can also install directly with cargo:

cargo install cargo-shuttle

After installing, log in with:

cargo shuttle login

To initialize your project, simply write:

cargo shuttle init --axum hello-world

Note: if you use sparse registries (which is enabled by default on nightly), you may encounter this bug when running the init command. To resolve this, see this comment.

And to deploy it, write:

cd hello-world
cargo shuttle project start  # Only needed if project has not already been created during init
cargo shuttle deploy

And that's... it.

$ cargo shuttle deploy
   Finished release [optimized + debuginfo] target(s) in 1m 01s

        Project:            hello-world
        Deployment Id:      3d08ac34-ad63-41c1-836b-99afdc90af9f
        Deployment Status:  DEPLOYED
        Host:               hello-world.shuttleapp.rs
        Created At:         2022-04-01 08:32:34.412602556 UTC

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.

Contributing to Shuttle

Contributing to Shuttle is highly encouraged!

If you want to setup a local environment to test code changes to core Shuttle packages, or want to contribute to the project check out our docs.

Even if you are not planning to submit any code; joining our Discord server and providing feedback helps us a lot!

Roadmap

For a comprehensive view of the Shuttle roadmap check out this project board.

If you have any requests or suggestions feel free to open an issue.

Community & Support

• Community Forum. Best for: help with building, discussion about best practices.
• GitHub Issues. Best for: bugs and errors you encounter using Shuttle.
• Discord. Best for: sharing your applications and hanging out with the community.
• Twitter. Best for: keeping up with announcements and releases.

Status

• Alpha: We are testing Shuttle, API and deployments may be unstable
• Public Alpha: Anyone can sign up, but go easy on us, there are a few kinks
• Public Beta: Stable enough for most non-enterprise use-cases
• Public: Production-ready!

We are currently in Public Alpha. Watch "releases" of this repo to get notified of major updates!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ben 📝 🐛 💻 ⚠️	Casey Bailey 🐛 📖	Christos Hadjiaslanis 📝 💻 👀 ⚠️ 📹 🐛	Damien 🐛 💻 📖 🔍 👀 ⚠️	David Laban 🐛 💻 ⚠️	Ivan 📝 🐛 💻 ⚠️	Lilian Anatolie Moraru 🖋
Luis Cossío 💻 ⚠️	Mario Idival 💻 ⚠️	Matthew Aylward 💻 ⚠️	Max 🐛 💻 💡 👀 ⚠️	Nahua 🐛 💻 ⚠️	Nodar Daneliya 💼 🔍	Oddbjørn Grødem 💻 ⚠️
Pieter 🐛 💻 💡 🧑‍🏫 👀 ⚠️ 📖	Tsotne Nazarashvili 🖋	Xavientois 🐛 💻 ⚠️	jmwill86 🐛 📖 ⚠️ 💻

This project follows the all-contributors specification. Contributions of any kind welcome!