mirror of https://github.com/rwf2/Rocket.git
113 lines
4.5 KiB
Markdown
113 lines
4.5 KiB
Markdown
# Rocket
|
|
|
|
[](https://github.com/rwf2/Rocket/actions)
|
|
[](https://rocket.rs)
|
|
[](https://crates.io/crates/rocket)
|
|
[](https://chat.mozilla.org/#/room/#rocket:mozilla.org)
|
|
|
|
Rocket is an async web framework for Rust with a focus on usability, security,
|
|
extensibility, and speed.
|
|
|
|
```rust
|
|
#[macro_use] extern crate rocket;
|
|
|
|
#[get("/<name>/<age>")]
|
|
fn hello(name: &str, age: u8) -> String {
|
|
format!("Hello, {} year old named {}!", age, name)
|
|
}
|
|
|
|
#[launch]
|
|
fn rocket() -> _ {
|
|
rocket::build().mount("/hello", routes![hello])
|
|
}
|
|
```
|
|
|
|
Visiting `localhost:8000/hello/John/58`, for example, will trigger the `hello`
|
|
route resulting in the string `Hello, 58 year old named John!` being sent to the
|
|
browser. If an `<age>` string was passed in that can't be parsed as a `u8`, the
|
|
route won't get called, resulting in a 404 error.
|
|
|
|
## Documentation
|
|
|
|
Rocket is extensively documented:
|
|
|
|
* [Overview]: A brief look at what makes Rocket special.
|
|
* [Quickstart]: How to get started as quickly as possible.
|
|
* [Getting Started]: How to start your first Rocket project.
|
|
* [Guide]: A detailed guide and reference to Rocket.
|
|
* [API Documentation]: The "rustdocs".
|
|
|
|
[Quickstart]: https://rocket.rs/guide/quickstart
|
|
[Getting Started]: https://rocket.rs/guide/getting-started
|
|
[Overview]: https://rocket.rs/overview/
|
|
[Guide]: https://rocket.rs/guide/
|
|
[API Documentation]: https://api.rocket.rs
|
|
|
|
Documentation for the `master` branch is available at https://rocket.rs/master
|
|
and https://api.rocket.rs/master.
|
|
|
|
Documentation for major release version `${x}` is available at
|
|
`https://[api.]rocket.rs/v${x}`. For example, the v0.4 docs are available at
|
|
https://rocket.rs/v0.4 and https://api.rocket.rs/v0.4.
|
|
|
|
Finally, API docs for active git branches are available at
|
|
`https://api.rocket.rs/${branch}`. For example, API docs for the `master` branch
|
|
are available at https://api.rocket.rs/master. Branch rustdocs are built and
|
|
deployed on every commit.
|
|
|
|
## Examples
|
|
|
|
The [examples](examples#readme) directory contains complete crates that showcase
|
|
Rocket's features and usage. Each example can be compiled and run with Cargo.
|
|
For instance, the following sequence of commands builds and runs the `hello`
|
|
example:
|
|
|
|
```sh
|
|
cd examples/hello
|
|
cargo run
|
|
```
|
|
|
|
## Getting Help
|
|
|
|
If you find yourself needing help outside of the documentation, you may:
|
|
|
|
* Ask questions via [GitHub discussions questions].
|
|
* Chat with us at [`#rocket:mozilla.org`] on Matrix (join [via Element]).
|
|
|
|
[`#rocket:mozilla.org`]: https://chat.mozilla.org/#/room/#rocket:mozilla.org
|
|
[via Element]: https://chat.mozilla.org/#/room/#rocket:mozilla.org
|
|
[GitHub discussions questions]: https://github.com/rwf2/Rocket/discussions/categories/questions
|
|
|
|
## Contributing
|
|
|
|
Contributions are absolutely, positively welcomed and encouraged! If you're
|
|
interested in contributing code, please first read [CONTRIBUTING] for complete
|
|
guidelines. Additionally, you could:
|
|
|
|
1. Submit a feature request or bug report as an [issue].
|
|
2. Ask for improved documentation as an [issue].
|
|
3. Comment on [issues that require feedback].
|
|
4. Answers questions in [GitHub discussions questions].
|
|
5. Share a project in [GitHub discussions show & tell].
|
|
|
|
[issue]: https://github.com/rwf2/Rocket/issues
|
|
[issues that require feedback]: https://github.com/rwf2/Rocket/issues?q=is%3Aissue+is%3Aopen+label%3A%22feedback+wanted%22
|
|
[pull requests]: https://github.com/rwf2/Rocket/pulls
|
|
[CONTRIBUTING]: CONTRIBUTING.md
|
|
[GitHub discussions show & tell]: https://github.com/rwf2/Rocket/discussions/categories/show-tell
|
|
|
|
## License
|
|
|
|
Rocket is licensed under either of the following, at your option:
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
|
|
* MIT License ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in Rocket by you shall be dual licensed under the MIT License and
|
|
Apache License, Version 2.0, without any additional terms or conditions.
|
|
|
|
The Rocket website docs are licensed under [separate terms](docs/LICENSE). Any
|
|
contribution intentionally submitted for inclusion in the Rocket website docs by
|
|
you shall be licensed under those terms.
|