Tsumanu/actix-admin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Manuel Gugger 2022-10-24 20:09:59 +02:00
parent 2ec5375463
commit 1e3f4fb80f
4 changed files with 11 additions and 221 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
README.md
View File

@ -2,114 +2,10 @@
The actix-admin crate aims at creating a web admin interface similar to other admin interfaces (such as [flask-admin](https://github.com/flask-admin/flask-admin) in python). The actix-admin crate aims at creating a web admin interface similar to other admin interfaces (such as [flask-admin](https://github.com/flask-admin/flask-admin) in python).
## Getting Started ## Usage
* See the [example](https://github.com/mgugger/actix-admin/tree/main/example) and run with ```cargo run```.
* See the step by [step tutorial](https://github.com/mgugger/actix-admin/tree/main/example/StepbyStep.md)
## Features See the [documentation](https://mgugger.github.io/actix-admin/) at [https://mgugger.github.io/actix-admin/](https://mgugger.github.io/actix-admin/).
1. Async: Builds on [sea-orm](https://crates.io/crates/sea-orm) for the database backend
2. Macros: Generate the required implementations for models automatically
3. Authentication: optionally pass authentication handler to implement authentication for views
4. Supports custom validation rules
5. Searchable attributes can be specified
6. Supports custom views which are added to the Navbar
## Screenshot
<img src="https://raw.githubusercontent.com/mgugger/actix-admin/main/static/Screenshot.png"/>
## Quick overview
### Required dependencies
itertools = "0.10.3"
sea-orm = { version = "^0.9.1", features = [ "sqlx-sqlite", "runtime-actix-native-tls", "macros" ], default-features = true }
actix_admin = { version = "^0.1.0" }
### See inlined steps
```
use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};
use actix_admin::prelude::*;
use actix_web::web;
use actix_web::App;
use actix_web::HttpServer;
use sea_orm::entity::prelude::*;
use sea_orm::entity::prelude::*;
use actix_admin::prelude::*;
// 1. Import ActixAdmin
use actix_admin::prelude::*;
// 2. Use DeriveActixAmin* Macros to implement the traits for the model
#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Deserialize, Serialize,
DeriveActixAdmin, DeriveActixAdminModel, DeriveActixAdminViewModel
)]
#[sea_orm(table_name = "comment")]
pub struct Model {
#[sea_orm(primary_key)]
#[serde(skip_deserializing)]
#[actix_admin(primary_key)]
pub id: i32,
pub comment: String
}
impl ActixAdminModelValidationTrait<ActiveModel> for Entity {}
impl ActiveModelBehavior for ActiveModel {}
#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub enum Relation { }
// 3. Add actix-admin to the AppState
#[derive(Clone)]
pub struct AppState {
pub db: DatabaseConnection,
pub actix_admin: ActixAdmin,
}
// 4. Implement the ActixAdminAppDataTrait for the AppState
impl ActixAdminAppDataTrait for AppState {
fn get_db(&self) -> &DatabaseConnection {
&self.db
}
fn get_actix_admin(&self) -> &ActixAdmin {
&self.actix_admin
}
}
// 5. Setup the actix admin configuration ## Example
pub fn create_actix_admin_builder() -> ActixAdminBuilder {
let comment_view_model = ActixAdminViewModel::from(Entity);
let configuration = ActixAdminConfiguration { Check the [example](https://github.com/mgugger/actix-admin/tree/main/example) and run with ```cargo run```. The admin interface is accessible under ```localhost:5000/admin/```.
enable_auth: false,
user_is_logged_in: None,
login_link: None,
logout_link: None,
};
let mut admin_builder = ActixAdminBuilder::new(configuration);
admin_builder.add_entity::<AppState, Entity>(&comment_view_model);
admin_builder
}
// 6. Add to the actix app
let actix_admin = create_actix_admin_builder().get_actix_admin();
//let opt = ConnectOptions::new("sqlite::memory:".to_owned());
//let conn = sea_orm::Database::connect(opt).unwrap();
//let app_state = AppState {
// db: conn,
// actix_admin: actix_admin,
//};
HttpServer::new(move || {
App::new()
//.app_data(web::Data::new(app_state.clone()))
.service(
create_actix_admin_builder().get_scope::<AppState>()
)
});
```
## Access
The admin interface will be available under /admin/.

2
docs/content/getting_started.md
View File

@ -1,5 +1,5 @@
--- ---
layout: default
--- ---
## Getting Started ## Getting Started

6
docs/index.md
View File

@ -1,5 +1,5 @@
--- ---
layout: home layout: default
list_title: ' ' list_title: ' '
--- ---
@ -13,6 +13,10 @@ The actix-admin crate aims at creating a web admin interface similar to other ad
5. Searchable attributes can be specified 5. Searchable attributes can be specified
6. Supports custom views which are added to the Navbar 6. Supports custom views which are added to the Navbar
## Example
Check the [example](https://github.com/mgugger/actix-admin/tree/main/example) and run with ```cargo run```. The admin interface is accessible under ```localhost:5000/admin/```.
## Screenshot ## Screenshot
<img src="https://raw.githubusercontent.com/mgugger/actix-admin/main/static/Screenshot.png"/> <img src="https://raw.githubusercontent.com/mgugger/actix-admin/main/static/Screenshot.png"/>

112
src/lib.rs
View File

@ -1,118 +1,8 @@
//! # Actix Admin //! # Actix Admin
//! //!
//! The actix-admin crate aims at creating a web admin interface similar to other admin interfaces (such as [flask-admin](https://github.com/flask-admin/flask-admin) in python). //! The actix-admin crate aims at creating a web admin interface similar to other admin interfaces (such as [flask-admin](https://github.com/flask-admin/flask-admin) in python).
//!
//! ## Getting Started
//!
//! * See the [example](https://github.com/mgugger/actix-admin/tree/main/example).
//! * See the step by [step tutorial](https://github.com/mgugger/actix-admin/tree/main/example/StepbyStep.md)
//!
//! ## Features
//! 1. Async, builds on [sea-orm](https://crates.io/crates/sea-orm) for the database backend
//! 2. Macros, generate the required implementations for models automatically
//! 3. Authentication, optionally pass authentication handler to implement authentication for views
//! 4. Supports custom validation rules
//! 5. Searchable attributes can be specified
//! 6. Supports a custom index view
//!
//! ## Screenshot
//!
//! <img src="https://raw.githubusercontent.com/mgugger/actix-admin/main/static/Screenshot.png"/>
//!
//! ## Quick overview
//!
//! ### Required dependencies
//! itertools = "0.10.3"
//! sea-orm = { version = "^0.9.1", features = [ "sqlx-sqlite", "runtime-actix-native-tls", "macros" ], default-features = true }
//! actix_admin = { version = "^0.1.0" }
//!
//! ### See inlined steps
//! ```
//! use sea_orm::entity::prelude::*;
//! use serde::{Deserialize, Serialize};
//! use actix_admin::prelude::*;
//! use actix_web::web;
//! use actix_web::App;
//! use actix_web::HttpServer;
//! use sea_orm::entity::prelude::*;
//! use sea_orm::entity::prelude::*;
//! use actix_admin::prelude::*;
//! // 1. Import ActixAdmin
//! use actix_admin::prelude::*;
//!
//! // 2. Use DeriveActixAmin* Macros to implement the traits for the model
//! #[derive(Clone, Debug, PartialEq, DeriveEntityModel, Deserialize, Serialize,
//! DeriveActixAdmin, DeriveActixAdminModel, DeriveActixAdminViewModel
//! )]
//! #[sea_orm(table_name = "comment")]
//! pub struct Model {
//! #[sea_orm(primary_key)]
//! #[serde(skip_deserializing)]
//! #[actix_admin(primary_key)]
//! pub id: i32,
//! pub comment: String
//! }
//! impl ActixAdminModelValidationTrait<ActiveModel> for Entity {}
//! impl ActiveModelBehavior for ActiveModel {}
//!
//! #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
//! pub enum Relation { }
//!
//! // 3. Add actix-admin to the AppState
//! #[derive(Clone)]
//! pub struct AppState {
//! pub db: DatabaseConnection,
//! pub actix_admin: ActixAdmin,
//! }
//!
//! // 4. Implement the ActixAdminAppDataTrait for the AppState
//! impl ActixAdminAppDataTrait for AppState {
//! fn get_db(&self) -> &DatabaseConnection {
//! &self.db
//! }
//!
//! fn get_actix_admin(&self) -> &ActixAdmin {
//! &self.actix_admin
//! }
//! }
//! //!
//! // 5. Setup the actix admin configuration //! See the [documentation](https://mgugger.github.io/actix-admin/) at [https://mgugger.github.io/actix-admin/](https://mgugger.github.io/actix-admin/).
//! pub fn create_actix_admin_builder() -> ActixAdminBuilder {
//! let comment_view_model = ActixAdminViewModel::from(Entity);
//!
//! let configuration = ActixAdminConfiguration {
//! enable_auth: false,
//! user_is_logged_in: None,
//! login_link: None,
//! logout_link: None,
//! };
//!
//! let mut admin_builder = ActixAdminBuilder::new(configuration);
//! admin_builder.add_entity::<AppState, Entity>(&comment_view_model);
//!
//! admin_builder
//! }
//!
//! // 6. Add to the actix app
//! let actix_admin = create_actix_admin_builder().get_actix_admin();
//! //let opt = ConnectOptions::new("sqlite::memory:".to_owned());
//! //let conn = sea_orm::Database::connect(opt).unwrap();
//! //let app_state = AppState {
//! // db: conn,
//! // actix_admin: actix_admin,
//! //};
//!
//! HttpServer::new(move || {
//! App::new()
//! //.app_data(web::Data::new(app_state.clone()))
//! .service(
//! create_actix_admin_builder().get_scope::<AppState>()
//! )
//! });
//! ```
//!
//! ## Access
//! The admin interface will be available under /admin/.
use lazy_static::lazy_static; use lazy_static::lazy_static;
use sea_orm::DatabaseConnection; use sea_orm::DatabaseConnection;