mirror of
https://github.com/SergioBenitez/Rocket.git
synced 2026-02-06 10:48:05 +00:00
8d3f1d65ac
The guide is now in docs/guide. All other site assets are being migrated to a separate repository. The guide markup has been upgraded to take advantages of improvements in the static site generator used to build the Rocket website.
36 lines
1.0 KiB
Markdown
36 lines
1.0 KiB
Markdown
+++
|
|
summary = "the minimal steps to running your first Rocket application"
|
|
+++
|
|
|
|
# Quickstart
|
|
|
|
Before you can start writing a Rocket application, you'll need to install the
|
|
Rust toolchain. We recommend using [rustup](https://rustup.rs/). If you don't
|
|
have Rust installed and would like extra guidance doing so, see [Getting
|
|
Started].
|
|
|
|
## Running Examples
|
|
|
|
The absolute fastest way to start experimenting with Rocket is to clone the
|
|
Rocket repository and run the included examples in the `examples/` directory.
|
|
For instance, the following set of commands runs the `hello` example:
|
|
|
|
```sh
|
|
git clone https://github.com/rwf2/Rocket
|
|
cd Rocket
|
|
git checkout master
|
|
cd examples/hello
|
|
cargo run
|
|
```
|
|
|
|
There are numerous examples in the `examples/` directory. They can all be run
|
|
with `cargo run`.
|
|
|
|
! note
|
|
|
|
The examples' `Cargo.toml` files will point to the locally cloned `rocket`
|
|
libraries. When copying the examples for your own use, you should modify the
|
|
`Cargo.toml` files as explained in the [Getting Started] guide.
|
|
|
|
[Getting Started]: ../getting-started/
|