fluxor

FLUXOR

Fluxor is a versatile Rust web framework designed for data science and computing science applications. Inspired by frameworks like Express.js, Flask, and Shiny, Fluxor provides a robust environment for developing applications that require efficient data handling and server management.

SEE CHANGELOG

Table of Contents

• Features
• Getting Started
• Documentation
• Modules
• Roadmap
• Examples
• Fluxor - CLI
• Logo Definition and Meaning
• Contributing
• License
• Author

Features

• Asynchronous: Built on the Tokio runtime for powerful non-blocking I/O.
• Robust: Offers a rich set of functionalities tailored for scientific computing and web development.
• Extendable: Easily integrate with other data storage solutions such as MongoDB, PostgreSQL, and Redis.
• CLI Tool: A dedicated CLI (fluxor_cli) for project scaffolding to expedite the development process.
• Modular: Comprises various modules like math, data handling, logging, and more to facilitate streamlined development.

Getting Started

To begin using Fluxor, ensure that you have Rust installed on your system. You can either create a new Fluxor project or add Fluxor to an existing project.

Option 1: Adding Fluxor to an Existing Project

If you're starting from scratch, you can add Fluxor directly to a new or existing Rust project using Cargo:

1. Create a new Rust project:

cargo new <project_name>
cd <project_name>

2. Add Fluxor as a dependency:

cargo add fluxor

Option 2: Creating a New Fluxor Project with the Fluxor CLI

If you prefer to use the Fluxor CLI to create a new project, you can do so with the following commands:

1. First, install the Fluxor CLI:

cargo install fluxor_cli

2. Create a new Fluxor project:

      
fluxor new <project_name> --version latest --example helloworld
    

Replace <project_name> with your desired project name.

Once the project scaffolding is complete, navigate into your project directory:

      
cd <project_name>
    

Now, you can build and run your Fluxor application:

      
cargo run
    

Your application should now be running on http://127.0.0.1:8080.

Documentation

Comprehensive documentation is available in the docs directory for further guidance on using Fluxor, modules, configuration, and deployment.

Modules

Fluxor is organized into several key modules:

• Core: The backbone of the framework providing essential functionalities.
• Client: A simple HTTP client built within the Fluxor framework for testing API endpoints, eliminating the need for external tools like Postman. This module allows developers to easily construct and send HTTP requests, view responses, and manage various request parameters, facilitating effective and streamlined API testing directly within the Fluxor environment.
• Data: a module for interacting with the MySQL storage system. The framework is designed to work effectively with various types of databases; however, MySQL was selected for its popularity and to keep the crate lightweight.
• Math: Contains functionalities for performing mathematical computations.
• StyledLog: Provides an efficient and aesthetically pleasing logging mechanism.
• Cans: An elegant and lightweight Rust-based literal template engine for managing web content, enhanced with a world module for streamlined access to regional and city information, as well as robust MIME type management.
• Wtime: Provides a variety of functions for obtaining the current UTC and local times, along with generating customizable timestamps to suit your needs.
• Fluxio: A wrapper around the Hyper crate, designed specifically for use within the Fluxor project. This module simplifies HTTP client functionalities, enhancing performance and integration within the Fluxor framework.

Roadmap

• Website: Develop a dedicated website for Fluxor that showcases its features and provides resources for users.

  Started from version 1.0.0, the website was developed and published at https://fluxor.one. Demo source code can be found via fluxor_cli.

  To install the Fluxor CLI, run:

  cargo install fluxor_cli
  

  Then, use the following command to create a complete Fluxor website template with full features:

  fluxor new fluxor_template --version latest --example fluxor-template
  

• Comprehensive Documentation: Expand the existing documentation to cover more use cases and detailed explanations of functionalities.

• More Examples and Scenarios: Add more examples and scenarios in fluxor_cli to help developers understand how to utilize the framework effectively.

• Middleware Enhancements: Already implemented additional features for handling request parameters (e.g., req.params.extra), similar to database integration. Future releases will aim to add more middleware functions to enhance Fluxor’s capabilities.

Examples

Hello World Example

A basic Fluxor application that responds with "Hello, World!" when accessed via a web browser.

use fluxor::prelude::*;

fn hello(_req: Req, _params: Params) -> Reply {
    boxed(async {
        Ok(Response::builder()
            .header("Content-Type", "text/html; charset=UTF-8")
            .body(Body::from("<h1>👋 Hello, World!</h1>"))
            .unwrap())
    })
}

#[tokio::main]
async fn main() {
    let mut app = Fluxor::new();			// Initialize the application.
    app.route(GET, "/", hello);				// Set the route (method, path, handler).
    app.run("127.0.0.1", "8080").await;		// Start the HTTP server (host, port).
}

API Examples

A simple Fluxor API endpoint that returns a JSON response (method: GET).

use fluxor::prelude::*;

fn hello(_req: Req, _params: Params) -> Reply {
    boxed(async move {
        let json_response = format!(r#"{{"message": "👋 Hello, World!"}}"#);
        
        Ok(Response::builder()
            .header("Content-Type", "application/json")
            .body(Body::from(json_response))
            .unwrap())
    })
}

#[tokio::main]
async fn main() {
    let mut app = Fluxor::new();							// Initialize the application.
    app.route(GET, "/", hello);								// Set the route (method, path, handler).
    app.route(GET, "/http-client", serve_http_client);  	// A simple http client to test your application.
    app.run("127.0.0.1", "8080").await;						// Start the HTTP server (host, port).
}   

A simple Fluxor API endpoint that returns a JSON response (method: POST).

use fluxor::prelude::*;

fn hello(_req: Req, _params: Params) -> Reply {
    boxed(async move {
       let json_response = do_json!(
        r#"
            {"message": "{{waving_hand_emoji}} Hello, World!"}
        "#, 
        waving_hand_emoji = "👋"
    );
        
        Ok(Response::builder()
            .header("Content-Type", "application/json")
            .body(Body::from(json_response))
            .unwrap())
    })
}

#[tokio::main]
async fn main() {
    let mut server = Fluxor::new();                     	// Initialize the application.
    server.route(POST, "/", hello);                     	// Set the route (method, path, handler).
    server.route(GET, "/http-client", serve_http_client);  	// A simple HTTP client to test your application.
    server.run("127.0.0.1", "8080").await;              	// Start the HTTP server (host, port).
}

Fluxor - CLI

The fluxor_cli allows users to quickly scaffold new Fluxor projects. Here's how to utilize it:

      
fluxor new <project_name> --version <version> --example <example-name>
    

• project_name: The name of your new project.
• version: The version of Fluxor to use (default is 'latest').
• example-name: Choose between example templates like helloworld or helloworld-api.

All Fluxor CLI Examples

1. Hello World

• helloworld
• helloworld-api
• helloworld-api-server

2. Routes

• routes
• routes-project

3. Assets

• assets

4. DotEnv

• dotenv

5. Cans

• cans-template-engine

6. Fluxor

• fluxor-template

Use the example name after the flag --example (e.g., helloworld):

fluxor new my_project --version latest --example helloworld

fluxor new my_app --version latest --example routes

fluxor new routes_app --version latest --example routes-project

fluxor new assets_example --version latest --example assets

fluxor new dotenv_example --version latest --example dotenv

fluxor new template_app --version latest --example cans-template-engine

fluxor new fluxor_template --version latest --example fluxor-template

Logo Definition and Meaning

The logo consists of a stylized letter "S" and an inverted letter "F." The letter "S" represents "server," while the letter "F" symbolizes the name of the framework "Fluxor." The logo features two colors: orange, representing the Rust programming language, and cyan, symbolizing "Fluxio," a Rust programming library for HTTP. Together, the logo conveys the image of a flame, indicating that the server is running.

Contributing

Contributions are welcome! If you'd like to contribute to Fluxor, please fork the repository, create a new branch, and submit a pull request. For larger changes, please discuss your ideas via an issue before implementing them.

License

Fluxor is licensed under either of the following licenses:

• MIT License
• Apache License, Version 2.0

See the LICENSE file for more details.

Author

Dr. Montasir Mirghani