Expand description
FLUXOR
Fluxor is a versatile Rust web framework designed for data science and computing science applications.
§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:
- Create a new Rust project:
cargo new <project_name>
cd <project_name>
- 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:
- First, install the Fluxor CLI:
cargo install fluxor
- 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.
§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 (path, method, 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 (path, method, handler).
server.route("/http-client", GET, 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 = 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 server = Fluxor::new(); // Initialize the application.
server.route("/", POST, hello); // Set the route (path, method, handler).
server.route("/http-client", GET, 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).
}