Feather

Feather is a lightweight, flexible, and highly extensible web framework for Rust, inspired by the simplicity and modularity of Express.js.

Features

• Middleware Support: Chain and compose middleware functions effortlessly.
• Route Handling: Support for multiple HTTP methods (GET, POST, PUT, DELETE, etc.).
• Lightweight: Built using Rust’s high-performance and memory-safe features.
• Thread-Safe: Leverages Rust's Thread Safe Aspects.

Installation

To get started with Feather, add it as a dependency in your Cargo.toml:

[dependencies]
feather = "0.1.1"

Quick Start

Here's an example of building a simple web server with Feather:

//*Import Dependencies from Feather
use feather::{App, AppConfig};
use feather::Response;
use feather::middlewares::Logger;
//*Main Function No Async Here
fn main() {
    //*Create instance of AppConfig with 4 threads
    let config = AppConfig { threads: 4 };

    //*Create a new instance of App
    let mut app = App::new(config);

    //*Define a route for the root path
    app.get("/", |_req| {
        Response::ok("Hello From Feather")
    });    
    //*Use the Logger middleware
    app.use_middleware(Logger);
    //*Listen on port 3000
    app.listen("127.0.0.1:3000");
}

Middleware

Feather supports middleware for pre-processing requests and post-processing responses. Here's an example:

//* Import Dependencies from Feather
use feather::{App, AppConfig};
use feather::Response;
use feather::middlewares::Logger;
//* Main Function No Async Here
fn main() {
    //* Create instance of AppConfig with 4 threads
    let config = AppConfig { threads: 4 };

    //* Create a new instance of App
    let mut app = App::new(config);

    //* Define a route for the root path
    app.get("/", |_req| {
        Response::ok("Hello From Feather")
    });    
    //* Use the Logger middleware
    app.use_middleware(Logger);
    //* Listen on port 3000
    app.listen("127.0.0.1:3000");
}

Built-in middlewares includes:

• Logger: Logs incoming Requests.
• Cors: Add Cross-Origin Resource Sharing Headers to your Response.

Goals

• Be the Simple & Beginner-Friendly Web Framework for Rust
• Be Modular and Expandable By Design
• Be Easy to Use and Learn

Non-Goals

• Be the most powerful/performant Web Framework
• Use Complex and Low-level features
• Be the most feature-rich Web Framework

Contributing

Contributions are welcome! If you have ideas for improving Feather or find a bug, feel free to open an issue or submit a pull request.

1. Fork the repository.
2. Create your feature branch: git checkout -b feature/my-feature.
3. Commit your changes: git commit -m 'Add my feature'.
4. Push to the branch: git push origin feature/my-feature.
5. Open a pull request.

License

Feather is open-source software, licensed under the MIT License.

Acknowledgments

Feather is inspired by the simplicity of Express.js and aims to bring similar productivity to the Rust ecosystem. Special thanks to the Rust community for their contributions to building robust tools and libraries.