Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gemrest/windmark
🏗️ Elegant & Highly Performant Async Gemini Server Framework for the Modern Age
https://github.com/gemrest/windmark
framework gemini gemini-server
Last synced: 3 months ago
JSON representation
🏗️ Elegant & Highly Performant Async Gemini Server Framework for the Modern Age
- Host: GitHub
- URL: https://github.com/gemrest/windmark
- Owner: gemrest
- License: gpl-3.0
- Created: 2022-03-27T06:38:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T23:42:31.000Z (4 months ago)
- Last Synced: 2024-10-31T11:35:40.952Z (3 months ago)
- Topics: framework, gemini, gemini-server
- Language: Rust
- Homepage: https://docs.rs/windmark
- Size: 472 KB
- Stars: 14
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gemini - Windmark - An elegant and highly performant async Gemini server framework (Servers / Graphical)
README
# Windmark
[](https://crates.io/crates/windmark)
[](https://docs.rs/windmark)
[](https://github.com/gemrest/windmark/actions/workflows/check.yaml)
Windmark is an elegant and highly performant, async Gemini server framework for
the modern age!
Now supporting both [Tokio](https://tokio.rs/) and [`async-std`](https://async.rs/)!
## Usage
A macro-based "`struct`-router" is currently being developed for Windmark. A
subset of Windmark's features are currently available for use through it. Check
out [Rossweisse](./rossweisse/) for more information!
### Features
| Feature | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------- |
| `default` | Base Windmark framework using [Tokio](https://tokio.rs/) |
| `logger` | Enables the default [`pretty_env_logger`](https://github.com/seanmonstar/pretty-env-logger) integration |
| `auto-deduce-mime` | Exposes `Response`s and macros that automatically fill MIMEs for non-Gemini responses |
| `response-macros` | Simple macros for all `Response`s |
| `tokio` | Marks [Tokio](https://tokio.rs/) as the asynchronous runtime |
| `async-std` | Marks [`async-std`](https://async.rs/) as the asynchronous runtime |
| `prelude` | Exposes the `prelude` module containing the most used Windmark features |
### Add Windmark and Tokio as Dependencies
```toml
# Cargo.toml
[dependencies]
windmark = "0.3.9"
tokio = { version = "1.26.0", features = ["full"] }
# If you would like to use the built-in logger (recommended)
# windmark = { version = "0.3.9", features = ["logger"] }
# If you would like to use the built-in MIME dedection when `Success`-ing a file
# (recommended)
# windmark = { version = "0.3.9", features = ["auto-deduce-mime"] }
# If you would like to use macro-based responses (as seen below)
# windmark = { version = "0.3.9", features = ["response-macros"] }
```
### Implementing a Windmark Server
```rust
// src/main.rs
// ...
#[windmark::main]
async fn main() -> Result<(), Box> {
windmark::router::Router::new()
.set_private_key_file("windmark_private.pem")
.set_certificate_file("windmark_public.pem")
.mount("/", windmark::success!("Hello, World!"))
.set_error_handler(|_|
windmark::response::Response::permanent_failure("This route does not exist!")
)
.run()
.await
}
```
### Implementing a Windmark Server Using Rossweisse
```rust
// src/main.rs
// ...
#[rossweisse::router]
struct Router;
#[rossweisse::router]
impl Router {
#[route(index)]
pub fn index(
_context: windmark::context::RouteContext,
) -> Response {
Response::success("Hello, World!")
}
}
// ...
```
## Examples
Examples can be found within the
[`examples/`](https://github.com/gemrest/windmark/tree/main/examples) directory
along with a rundown of each of their purposes and useful facts.
Run an example by cloning this repository and running `cargo run --example example_name`.
## Modules
Modules are composable extensions which can be procedurally mounted onto Windmark
routers.
### Examples
- [Simple Stateless Module](https://github.com/gemrest/windmark/blob/main/examples/stateless_module.rs)
\- Mounts the `/smiley` route, returning an 😀 emoji
- [Simple Stateful Module](https://github.com/gemrest/windmark/blob/main/examples/stateful_module.rs)
\- Adds a click tracker (route hit tracker) that additionally notifies before and after route visits
- [Windmark Comments](https://github.com/gemrest/windmark-comments) - A fully featured comment engine
for your capsule
## License
This project is licensed with the
[GNU General Public License v3.0](https://github.com/gemrest/windmark/blob/main/LICENSE).