From e13166887cc5c34e25bc4f3200c315e8db119263 Mon Sep 17 00:00:00 2001 From: Lev Kokotov Date: Fri, 22 Nov 2024 10:00:00 -0800 Subject: [PATCH] Publish rwf-admin --- rwf-admin/Cargo.toml | 7 ++++++- rwf-admin/README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 rwf-admin/README.md diff --git a/rwf-admin/Cargo.toml b/rwf-admin/Cargo.toml index c76d38a..d30c439 100644 --- a/rwf-admin/Cargo.toml +++ b/rwf-admin/Cargo.toml @@ -2,8 +2,13 @@ name = "rwf-admin" version = "0.1.10" edition = "2021" +description = "Admin panel for applications written with the Rust Web Framework" +homepage = "https://levkk.github.io/rwf/" +repository = "https://github.com/levkk/rwf" +keywords = ["mvc", "web", "framework", "http", "orm", "admin"] +authors = ["Lev Kokotov "] include = ["/templates", "/src"] - +readme = "README.md" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/rwf-admin/README.md b/rwf-admin/README.md new file mode 100644 index 0000000..7e2b188 --- /dev/null +++ b/rwf-admin/README.md @@ -0,0 +1,34 @@ +# Rwf admin + +[![Documentation](https://img.shields.io/badge/documentation-blue?style=flat)](https://levkk.github.io/rwf/) +[![Latest crate](https://img.shields.io/crates/v/rwf-admin.svg)](https://crates.io/crates/rwf-admin) +[![Reference docs](https://img.shields.io/docsrs/rwf-admin)](https://docs.rs/rwf/latest/rwf-admin/) + +[Rwf](https://crates.io/crates/rwf) admin panel is a web application that provides a real time overview into web activity, background jobs queue insights, and allows to manipulate database models. + +The admin panel can run as a standalone application or be integrated into an existing Rwf application. + +## Installation + +To install Rwf admin panel into your application, you need to add it to your routes and preload its templates at application startup: + +```rust +use rwf::prelude::*; +use rwf::http::{Server, Error}; + +#[tokio::main] +async fn main() -> Result<(), Error> { + rwf_admin::install()?; + + let mut routes = vec![]; + // Add your routes... + + routes.extend(rwf_admin::routes()); + + Server::new(routes) + .launch("0.0.0.0:8000") + .await +} +``` + +The admin panel is now running on [https://localhost:8000/admin/](https://localhost:8000/admin/).