Skip to content

Latest commit

 

History

History
196 lines (145 loc) · 8.31 KB

README.md

File metadata and controls

196 lines (145 loc) · 8.31 KB
Raw


language docs crate-docs status build status

crates discord Twitter Follow

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:

📖 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

Shuttle Console

In addition to the CLI, you can also view your projects on the Shuttle Console!

console-preview The GIF above visualizes the ease of adding resources to your project(s), along with how they are displayed in 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.

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

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

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

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

Our binaries can also be installed using cargo-binstall. 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

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

cargo install cargo-shuttle

If installing cargo-binstall or cargo-shuttle fails, try adding --locked to the install command

After installing, log in with:

cargo shuttle login

To initialize your project, simply write:

cargo shuttle init --template axum hello-world

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.

Repositories

Name Description
shuttle 🚀 (This repo) The core Shuttle product. Contains all crates that users interact with.
shuttle-examples 👨‍🏫 Officially maintained examples of projects that can be deployed on Shuttle. Also has a list of community examples.
shuttle-docs 📃 Documentation hosted on docs.shuttle.rs.
www 🌍 Our website shuttle.rs, including the blog and Launchpad newsletter.
deploy-action ⚙ GitHub Action for continuous deployments.
awesome-shuttle 🌟 An awesome list of Shuttle-hosted projects and resources that users can add to.
shuttlings ⚔️ A collection of Rust code challenges. A great way to get started with using Rust and Shuttle.

Contributing to Shuttle

Contributing to Shuttle is highly encouraged! Even if you are not planning to submit any code, joining our Discord server and providing feedback helps us a lot!

Check out our contributing docs and find the appropriate repo above to contribute to. For development of this repo, check the development docs.

Algora Bounties 💰

To offload work from the engineering team on low-priority issues, we will sometimes add a cash bounty to issues. Sign up to the Algora Console to find open issues with bounties.

Community and Support

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

Project Status

Check for any outages and incidents on Shuttle Status.

We are currently in Public Beta. Watch "releases" of this repo to get notified of major updates! Also, check out the Beta announcement for features we are looking forward to.

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

Made with contrib.rocks.