2017-04-17 02:48:59 +00:00
|
|
|
# The Rocket Programming Guide
|
|
|
|
|
|
|
|
|
|
Welcome to Rocket!
|
|
|
|
|
|
2021-06-09 08:53:34 +00:00
|
|
|
This is the official guide for Rocket v0.5. It is designed to serve as a
|
2018-10-22 21:47:35 +00:00
|
|
|
starting point to writing web applications with Rocket and Rust. The guide is
|
|
|
|
|
also designed to be a reference for experienced Rocket developers. This guide is
|
|
|
|
|
conversational in tone. For purely technical documentation with examples, see
|
|
|
|
|
the [API documentation](@api).
|
2017-04-17 02:48:59 +00:00
|
|
|
|
|
|
|
|
The guide is split into several sections, each with a focus on a different
|
|
|
|
|
aspect of Rocket. The sections are:
|
|
|
|
|
|
|
|
|
|
- **[Introduction](introduction/):** introduces Rocket and its philosophy.
|
|
|
|
|
- **[Quickstart](quickstart/):** presents the minimal steps necessary to
|
|
|
|
|
run your first Rocket application.
|
2022-06-21 20:40:23 +00:00
|
|
|
- **[Upgrading from v0.4](upgrading/):** a migration guide from v0.4 to v0.5.
|
2017-04-17 02:48:59 +00:00
|
|
|
- **[Getting Started](getting-started/):** a gentle introduction to getting
|
|
|
|
|
your first Rocket application running.
|
|
|
|
|
- **[Overview](overview/):** describes the core concepts of Rocket.
|
|
|
|
|
- **[Requests](requests/):** discusses handling requests: control-flow,
|
|
|
|
|
parsing, and validating.
|
|
|
|
|
- **[Responses](responses/):** discusses generating responses.
|
|
|
|
|
- **[State](state/):** how to manage state in a Rocket application.
|
2017-07-10 11:59:55 +00:00
|
|
|
- **[Fairings](fairings/):** provides an overview of Rocket's structured
|
|
|
|
|
middleware.
|
2017-04-17 02:48:59 +00:00
|
|
|
- **[Testing](testing/):** how to unit and integration test a Rocket
|
|
|
|
|
application.
|
2017-07-05 02:21:46 +00:00
|
|
|
- **[Configuration](configuration/):** how to configure a Rocket application.
|
2022-06-21 20:40:23 +00:00
|
|
|
- **[Pastebin Tutorial](pastebin-tutorial/):** a tutorial creating a pastebin
|
2022-05-08 06:57:49 +00:00
|
|
|
with Rocket.
|
2017-04-17 02:48:59 +00:00
|
|
|
- **[Conclusion](conclusion/):** concludes the guide and discusses next steps
|
|
|
|
|
for learning.
|
2021-08-20 02:43:05 +00:00
|
|
|
- **[FAQ](faq/):** answers to frequently asked questions about Rocket and
|
|
|
|
|
using it.
|
2017-04-17 02:48:59 +00:00
|
|
|
|
|
|
|
|
## Getting Help
|
|
|
|
|
|
2020-02-27 22:37:27 +00:00
|
|
|
The official community support channels are [`#rocket:mozilla.org`] on Matrix
|
2021-06-12 13:18:00 +00:00
|
|
|
and the bridged [`#rocket`] IRC channel on Libera.Chat at `irc.libera.chat`. We
|
2020-11-24 15:40:57 +00:00
|
|
|
recommend joining us on [Matrix via Element]. If you prefer IRC, you can join
|
2021-08-29 23:55:05 +00:00
|
|
|
via the [Kiwi IRC client] or a client of your own. The [FAQ](../faq/) also
|
|
|
|
|
provides answers to commonly asked questions.
|
2020-02-27 22:37:27 +00:00
|
|
|
|
|
|
|
|
[`#rocket:mozilla.org`]: https://chat.mozilla.org/#/room/#rocket:mozilla.org
|
2021-06-12 13:18:00 +00:00
|
|
|
[`#rocket`]: https://kiwiirc.com/client/irc.libera.chat/#rocket
|
2020-07-22 20:03:23 +00:00
|
|
|
[Matrix via Element]: https://chat.mozilla.org/#/room/#rocket:mozilla.org
|
2021-06-12 13:18:00 +00:00
|
|
|
[Kiwi IRC Client]: https://kiwiirc.com/client/irc.libera.chat/#rocket
|
