Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radical-ui/objection
Build server-first, highly-interactive, and beautiful web applications in Rust
https://github.com/radical-ui/objection
component library svelte svelte-components ui uikit
Last synced: 19 days ago
JSON representation
Build server-first, highly-interactive, and beautiful web applications in Rust
- Host: GitHub
- URL: https://github.com/radical-ui/objection
- Owner: radical-ui
- License: mit
- Created: 2019-06-17T20:24:59.000Z (over 5 years ago)
- Default Branch: next
- Last Pushed: 2024-10-30T19:00:31.000Z (about 2 months ago)
- Last Synced: 2024-11-21T06:42:46.937Z (about 1 month ago)
- Topics: component, library, svelte, svelte-components, ui, uikit
- Language: Rust
- Homepage:
- Size: 4.71 MB
- Stars: 78
- Watchers: 6
- Forks: 4
- Open Issues: 19
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Objection
Build server-first, highly-interactive, and beautiful web applications in Rust.
...because the current web-based application development trends are worth objecting to.
> Due to an ongoing refactor, breaking changes are expected in the near future. See [#320](https://github.com/radical-ui/objection/pull/320) for current status.
## Installation
Unfortunately, [Deno](https://deno.com/) is a required runtime dependency. We aim to remove this dependency in the near future.
```sh
# MacOS
brew install radical-ui/tap/objection
# Linux / Windows
cargo install --git https://github.com/radical-ui/objection.git --bin objection
```
## Usage
Objection works by generating a network bridge, allowing a series of typescript components (referred to as the runtime)
to be managed by your backend (referred to as the engine). In practice, it feels like a merge between Phenix Liveview
and HTMX.
The default runtime is located in the `runtime` folder, but you can create and use your own.
### Rust Engine
The runtime can be started, and Rust bindings generated, by using the following command:
```sh
objection --engine rust --bindings-path src/bindings.rs --engine-url http://localhost:8000/ui run
```
The corresponding Rust engine can be written like so:
```rust
// src/main.rs
use axum::{extract::State, routing::post, Json, Router};
use bindings::Label;
use objection::{handle_request, RootUi, UiResponse};
use tokio::net::TcpListener;
use tower_http::cors::CorsLayer;
mod bindings;
#[tokio::main]
async fn main() {
let app = Router::new()
.route(
"/ui",
post(move |Json(body): Json| async move {
Json(handle_request(body, |_, ui| async {
ui.set_root_ui(Label::new("Hello, world!"));
Ok(ui.into_reponse())
}).await)
}),
)
.layer(CorsLayer::very_permissive());
let listener = TcpListener::bind(("localhost", 8000)).await.unwrap();
println!("listening at http://localhost:8000");
axum::serve(listener, app).await.unwrap();
}
```
That should do it. After starting the engine, navigate to the app server that objection will have started at `http://localhost:3000`.
Behind the scenes, the app will connect to the engine at `http://localhost:8000` over the generated network bridge.
## Development
You'll want to make sure that you have development dependencies installed:
- [Rust](https://www.rust-lang.org/tools/install)
- [Runner](https://github.com/stylemistake/runner)
- [WatchExec](https://github.com/watchexec/watchexec)
- [Deno](https://deno.com/)
- [Ripgrep](https://github.com/BurntSushi/ripgrep)
- [sd](https://github.com/chmln/sd)
- [Static Web Server](https://github.com/static-web-server/static-web-server)
Then, start up the example project:
```sh
runner dev
```