# Rust Internet Boilerplate Server - 🍖 RIBS
Ribs helps you to set a minimal web server to start a new project in a second.
## 📦 Installation
1. start a new rust project:
```bash
cargo init
```
2. add ribs to your dependencies:
```bash
cargo add ribs axum tokio --features tokio/full
```
3. create a *.env* file in the root directory of your project and add the following environment variables:
```env
ENV=development
HOST=127.0.0.1
LOG_LEVEL=debug
PORT=3000
```
> others options are :
ENV = development | production
HOST = any valid IP address
LOG_LEVEL = error | warn | info | debug | trace
PORT = any valid port number between 1024 and 65535
### the code
add the following code to your main.rs file:
```rust
use ribs::prelude::*;
use axum::{Router, routing::get, response::Html};
#[tokio::main]
async fn main() -> Result<(), ServerError> {
let config = ServerConfig::from_env()?;
let router = Router::new()
.route("/", get(home));
start_server(config, router).await
}
async fn home() -> Html<&'static str> {
Html("<h1>Hello World!</h1>")
}
```
## 🚀 Usage
to run the server, use the following command:
```bash
cargo run
# -> Server running at http://127.0.0.1:3000
```