🚧 [pagetop] Preparando liberación de la v0.1.0
This commit is contained in:
parent
223a98569b
commit
fe81ed1cd7
6 changed files with 144 additions and 2 deletions
34
CREDITS.md
Normal file
34
CREDITS.md
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
# 🔃 Dependencias
|
||||||
|
|
||||||
|
`PageTop` está basado en [Rust](https://www.rust-lang.org/) y crece a hombros de gigantes
|
||||||
|
aprovechando algunas de las librerías más robustas y populares del [ecosistema Rust](https://lib.rs)
|
||||||
|
como son:
|
||||||
|
|
||||||
|
* [Actix Web](https://actix.rs/) para los servicios web.
|
||||||
|
* [Config](https://docs.rs/config) para cargar y procesar las opciones de configuración.
|
||||||
|
* [Tracing](https://github.com/tokio-rs/tracing) para la gestión de trazas y registro de eventos
|
||||||
|
de la aplicación.
|
||||||
|
* [Fluent templates](https://github.com/XAMPPRocky/fluent-templates), que integra
|
||||||
|
[Fluent](https://projectfluent.org/) para internacionalizar las aplicaciones.
|
||||||
|
* Además de otros crates adicionales que se pueden explorar en los archivos `Cargo.toml` de
|
||||||
|
`PageTop` y sus extensiones.
|
||||||
|
|
||||||
|
|
||||||
|
# 🗚 FIGfonts
|
||||||
|
|
||||||
|
`PageTop` usa el *crate* [figlet-rs](https://crates.io/crates/figlet-rs) desarrollado por
|
||||||
|
*yuanbohan* para mostrar un banner de presentación en el terminal con el nombre de la aplicación en
|
||||||
|
caracteres [FIGlet](http://www.figlet.org). Las fuentes incluidas en `pagetop/src/app` son:
|
||||||
|
|
||||||
|
* [slant.flf](http://www.figlet.org/fontdb_example.cgi?font=slant.flf) de *Glenn Chappell*
|
||||||
|
* [small.flf](http://www.figlet.org/fontdb_example.cgi?font=small.flf) de *Glenn Chappell*
|
||||||
|
(predeterminada)
|
||||||
|
* [speed.flf](http://www.figlet.org/fontdb_example.cgi?font=speed.flf) de *Claude Martins*
|
||||||
|
* [starwars.flf](http://www.figlet.org/fontdb_example.cgi?font=starwars.flf) de *Ryan Youck*
|
||||||
|
|
||||||
|
|
||||||
|
# 🎨 Icono
|
||||||
|
|
||||||
|
"La Criatura" sonriente es una simpática creación de [Webalys](https://www.iconfinder.com/webalys).
|
||||||
|
Forma parte de su colección [Nasty Icons](https://www.iconfinder.com/iconsets/nasty), disponible en
|
||||||
|
[ICONFINDER](https://www.iconfinder.com).
|
2
Cargo.lock
generated
2
Cargo.lock
generated
|
@ -1569,7 +1569,7 @@ checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pagetop"
|
name = "pagetop"
|
||||||
version = "0.0.14"
|
version = "0.0.61"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"actix-files",
|
"actix-files",
|
||||||
"actix-session",
|
"actix-session",
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "pagetop"
|
name = "pagetop"
|
||||||
version = "0.0.14"
|
version = "0.0.61"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
|
||||||
description = """\
|
description = """\
|
||||||
|
|
64
README.md
64
README.md
|
@ -7,11 +7,25 @@
|
||||||
<p>Un entorno para el desarrollo de soluciones web modulares, extensibles y configurables.</p>
|
<p>Un entorno para el desarrollo de soluciones web modulares, extensibles y configurables.</p>
|
||||||
|
|
||||||
[](#-license)
|
[](#-license)
|
||||||
|
[](https://docs.rs/pagetop)
|
||||||
|
[](https://crates.io/crates/pagetop)
|
||||||
|
[](https://crates.io/crates/pagetop)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
`PageTop` reivindica la esencia de la web clásica usando [Rust](https://www.rust-lang.org/es) para
|
`PageTop` reivindica la esencia de la web clásica usando [Rust](https://www.rust-lang.org/es) para
|
||||||
la creación de soluciones web SSR (*renderizadas en el servidor*) basadas en HTML, CSS y JavaScript.
|
la creación de soluciones web SSR (*renderizadas en el servidor*) basadas en HTML, CSS y JavaScript.
|
||||||
|
Ofrece un conjunto de herramientas que los desarrolladores pueden implementar, extender o adaptar
|
||||||
|
según las necesidades de cada proyecto, incluyendo:
|
||||||
|
|
||||||
|
* **Acciones** (*actions*): alteran la lógica interna de una funcionalidad interceptando su flujo
|
||||||
|
de ejecución.
|
||||||
|
* **Componentes** (*components*): encapsulan HTML, CSS y JavaScript en unidades funcionales,
|
||||||
|
configurables y reutilizables.
|
||||||
|
* **Extensiones** (*extensions*): añaden, extienden o personalizan funcionalidades usando las APIs
|
||||||
|
de `PageTop` o de terceros.
|
||||||
|
* **Temas** (*themes*): son extensiones que permiten modificar la apariencia de páginas y
|
||||||
|
componentes sin comprometer su funcionalidad.
|
||||||
|
|
||||||
|
|
||||||
# ⚡️ Guía rápida
|
# ⚡️ Guía rápida
|
||||||
|
@ -27,6 +41,55 @@ async fn main() -> std::io::Result<()> {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Sólo con esto, este código sirve por defecto una página web de bienvenida accesible desde un
|
||||||
|
navegador en la dirección `http://localhost:8080` con la configuración predeterminada.
|
||||||
|
|
||||||
|
Para personalizar el servicio, se puede crear una extensión de `PageTop` de la siguiente manera:
|
||||||
|
|
||||||
|
```rust
|
||||||
|
use pagetop::prelude::*;
|
||||||
|
|
||||||
|
struct HelloWorld;
|
||||||
|
|
||||||
|
impl Extension for HelloWorld {
|
||||||
|
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||||
|
scfg.route("/", service::web::get().to(hello_world));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn hello_world(request: HttpRequest) -> ResultPage<Markup, ErrorPage> {
|
||||||
|
Page::new(Some(request))
|
||||||
|
.with_component(Html::with(move |_| html! { h1 { "Hello World!" } }))
|
||||||
|
.render()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[pagetop::main]
|
||||||
|
async fn main() -> std::io::Result<()> {
|
||||||
|
Application::prepare(&HelloWorld).run()?.await
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Este programa implementa una extensión llamada `HelloWorld` que sirve una página web en la ruta raíz
|
||||||
|
(`/`) mostrando el texto "Hello world!" dentro de un elemento HTML `<h1>`.
|
||||||
|
|
||||||
|
|
||||||
|
# 📂 Repositorio
|
||||||
|
|
||||||
|
El código se organiza en un *workspace* donde actualmente se incluyen los siguientes subproyectos:
|
||||||
|
|
||||||
|
* **[pagetop](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/src)**, con el código
|
||||||
|
fuente de la librería principal. Reúne algunos de los *crates* más estables y populares del
|
||||||
|
ecosistema Rust para proporcionar APIs y recursos para la creación avanzada de soluciones web.
|
||||||
|
|
||||||
|
## Auxiliares
|
||||||
|
|
||||||
|
* **[pagetop-build](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-build)**,
|
||||||
|
permite incluir fácilmente archivos estáticos o archivos SCSS compilados directamente en el
|
||||||
|
binario de las aplicaciones `PageTop`.
|
||||||
|
|
||||||
|
* **[pagetop-macros](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-macros)**,
|
||||||
|
proporciona una colección de macros que mejoran la experiencia de desarrollo con `PageTop`.
|
||||||
|
|
||||||
|
|
||||||
# 🧪 Pruebas
|
# 🧪 Pruebas
|
||||||
|
|
||||||
|
@ -37,6 +100,7 @@ Para simplificar el flujo de trabajo, el repositorio incluye varios **alias de C
|
||||||
| ------- | ----------- |
|
| ------- | ----------- |
|
||||||
| `cargo ts` | Ejecuta los tests de `pagetop` (*unit + integration*) con la *feature* `testing`. |
|
| `cargo ts` | Ejecuta los tests de `pagetop` (*unit + integration*) con la *feature* `testing`. |
|
||||||
| `cargo ts --test util` | Lanza sólo las pruebas de integración del módulo `util`. |
|
| `cargo ts --test util` | Lanza sólo las pruebas de integración del módulo `util`. |
|
||||||
|
| `cargo ts --doc locale` | Lanza las pruebas de la documentación del módulo `locale`. |
|
||||||
| `cargo tw` | Ejecuta los tests de **todos los paquetes** del *workspace*. |
|
| `cargo tw` | Ejecuta los tests de **todos los paquetes** del *workspace*. |
|
||||||
|
|
||||||
> **Nota**
|
> **Nota**
|
||||||
|
|
24
examples/hello-name.rs
Normal file
24
examples/hello-name.rs
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
use pagetop::prelude::*;
|
||||||
|
|
||||||
|
struct HelloName;
|
||||||
|
|
||||||
|
impl Extension for HelloName {
|
||||||
|
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||||
|
scfg.route("/hello/{name}", service::web::get().to(hello_name));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn hello_name(
|
||||||
|
request: HttpRequest,
|
||||||
|
path: service::web::Path<String>,
|
||||||
|
) -> ResultPage<Markup, ErrorPage> {
|
||||||
|
let name = path.into_inner();
|
||||||
|
Page::new(Some(request))
|
||||||
|
.with_component(Html::with(move |_| html! { h1 { "Hello " (name) "!" } }))
|
||||||
|
.render()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[pagetop::main]
|
||||||
|
async fn main() -> std::io::Result<()> {
|
||||||
|
Application::prepare(&HelloName).run()?.await
|
||||||
|
}
|
20
examples/hello-world.rs
Normal file
20
examples/hello-world.rs
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
use pagetop::prelude::*;
|
||||||
|
|
||||||
|
struct HelloWorld;
|
||||||
|
|
||||||
|
impl Extension for HelloWorld {
|
||||||
|
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||||
|
scfg.route("/", service::web::get().to(hello_world));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn hello_world(request: HttpRequest) -> ResultPage<Markup, ErrorPage> {
|
||||||
|
Page::new(Some(request))
|
||||||
|
.with_component(Html::with(move |_| html! { h1 { "Hello World!" } }))
|
||||||
|
.render()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[pagetop::main]
|
||||||
|
async fn main() -> std::io::Result<()> {
|
||||||
|
Application::prepare(&HelloWorld).run()?.await
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue