Skip to content

morlinbrot/shuttle

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


docs language build status discord

open bounties rewarded bounties


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 Web, 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.

star

Console Sneak Peek (gif)

console-sneak-peek 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

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 can also be installed directly as a binary to skip the compilation time: https://github.com/cargo-bins/cargo-binstall#installation
cargo install cargo-binstall
cargo binstall cargo-shuttle
# If installing binstall or cargo-shuttle fails, try adding `--locked` to the install command

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 --template axum hello-world
# Choose a unique project name!

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 --allow-dirty

And... that's it!

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.

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!

Community & Support

  • GitHub Issues. Best for: bugs and errors you encounter using Shuttle.
  • Twitter. Best for: keeping up with announcements and releases.
  • Discord. Best for: ALL OF THE ABOVE + help, support, sharing your applications and hanging out with the community.

Status

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

  • 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!

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!

About

Deploy Rust apps with a single Cargo command

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 97.7%
  • Other 2.3%