Krustie - A Basic Backend Framework

Krustie is a backend written in Rust. It is a work in progress and is not yet ready for use.

It is a hobby project and is intended to be a learning experience for me. I am not a professional developer and I am learning as I go. I am open to feedback and suggestions.

Features

• Basic request and response handling
• Stacked Router
• Server Middleware support (Router Middleware support will be added soon)
• Static file serving

Getting Started

Prerequisites

• Rust
• Cargo

Installation

1. Add Krustie to your Cargo.toml:

[dependencies]

krustie = "0.1.3"

2. Start your server:

use krustie::{ server::Server, router::Router, response::{ HttpResponse, StatusCode }, middleware::Middleware };
use std::collections::HashMap;

fn main() {
    let mut server = Server::create(8080).unwrap();
    let mut router = Router::new("home");

    router
        .get(|_, res| {
            res.status(StatusCode::Ok);
        })
        .post(|_, res| {
            res.status(StatusCode::Ok);
        });

    let middleware = Middleware::new(|_, res: &mut HttpResponse| {
        let mut headers: HashMap<String, String> = HashMap::new();
        headers.insert(String::from("Server"), String::from("Rust"));
        res.headers(headers);
    });
    
    server.use_handler(router);
    server.use_handler(middleware);

    server.listen();
}

3. Run your server:

cargo run

Contributing

As an inexperienced developer contributions will be welcomed. Please open an issue or a pull request.

Planned Features

Basic Server Features

• Database support
• Authentication
• Authorization
• Error handling
• File uploads
• Websockets

Basic Web Server Features

• Templating
• Session management

Basic API Server Features

• JSON parsing
• XML parsing
• Query parameter parsing
• Request validation
• Response formatting

Security

• Rate limiting
• CSRF protection
• XSS protection
• SQL injection protection
• Secure headers
• Content Security Policy

Performance

• Caching
• Compression
• Connection pooling
• Load balancing
• Clustering

Monitoring

• Metrics
• Tracing
• Logging

Documentation

• API documentation
• Code documentation
• Examples