https://github.com/tntmeijs/webby
Rust web server implementation
https://github.com/tntmeijs/webby
http rust webserver
Last synced: 8 months ago
JSON representation
Rust web server implementation
- Host: GitHub
- URL: https://github.com/tntmeijs/webby
- Owner: tntmeijs
- License: mit
- Created: 2021-04-27T08:22:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-08T08:51:06.000Z (almost 5 years ago)
- Last Synced: 2025-02-28T06:20:35.048Z (about 1 year ago)
- Topics: http, rust, webserver
- Language: Rust
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Webby
Webby is a simple Rust web server that supports HTTP 1.1.
## Motivation
The Rust ecosystem comes with a lot of third-party web server crates.
A lot of crates are absolutely brilliant, but none of them really teach you how a web server works.
This crate allows me to discover how HTTP 1.1 works, how to handle requests, asynchronous programming, and much, much more!
Right now, I wouldn't recommend using this crate in any serious projects. It's simply too slow and unreliable.
## Features
### Create a simple HTTP server
```rust
// Run a server on localhost:8080
fn main() {
webby::create("127.0.0.1", 8080)
.start_listening();
}
```
### Routing
No web server would be complete without any sort of routing, which is why Webby supports routing too.
You can either use functions, or lambda functions. As long as you match the expected function signature, it'll work!
```rust
fn index() -> HttpResponse {
println!("This is an index route, it only ever returns HTTP 204.");
HttpResponse::new().no_content()
}
fn main() {
webby::create("127.0.0.1", 8080)
.add_route(HttpMethod::GET, "/", index)
.start_listening();
}
```
## Pull request guide
1. Create a branch from `master` using the following format: `feature/`.
2. Make your changes.
3. Write unit tests.
4. Test your changes.
5. Rebase on `master`.
6. Update the status badge in `README.md`.
7. Open a pull request.
8. Add a proper changelog / pull request description.
## Third-party dependencies
I've tried to keep Webby as simple as possible. However, some tasks are just out of scope for this project.
### Demo
- [Env Logger](https://crates.io/crates/env_logger) - a logger that can be configured via environment variables
- [DotEnv](https://crates.io/crates/dotenv) - load environment variables from a `.env` file
### Webby
- [Log](https://crates.io/crates/log) - lightweight logging facade