diff --git a/Cargo.lock b/Cargo.lock index 906b338..7cba8b9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1600,7 +1600,7 @@ dependencies = [ [[package]] name = "pagetop-build" -version = "0.0.1" +version = "0.0.16" dependencies = [ "grass", "static-files", @@ -1608,7 +1608,7 @@ dependencies = [ [[package]] name = "pagetop-macros" -version = "0.0.5" +version = "0.0.18" dependencies = [ "proc-macro2", "proc-macro2-diagnostics", diff --git a/Cargo.toml b/Cargo.toml index 6844b7b..a1a6bfc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,8 +3,8 @@ name = "pagetop" version = "0.0.61" edition = "2021" -description = """\ - Un entorno de desarrollo para crear soluciones web modulares, extensibles y configurables.\ +description = """ + Un entorno de desarrollo para crear soluciones web modulares, extensibles y configurables. """ categories = ["web-programming", "gui", "development-tools", "asynchronous"] keywords = ["pagetop", "web", "framework", "frontend", "ssr"] diff --git a/README.md b/README.md index 2619cb6..e671b50 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ 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. +Este código arranca el servidor de `PageTop` que, con la configuración por defecto, muestra una +página de bienvenida accesible desde un navegador local en `http://localhost:8080`. Para personalizar el servicio, se puede crear una extensión de `PageTop` de la siguiente manera: diff --git a/helpers/pagetop-build/Cargo.toml b/helpers/pagetop-build/Cargo.toml index 4b947b3..c6d9d51 100644 --- a/helpers/pagetop-build/Cargo.toml +++ b/helpers/pagetop-build/Cargo.toml @@ -1,11 +1,11 @@ [package] name = "pagetop-build" -version = "0.0.1" +version = "0.0.16" edition = "2021" -description = """\ - Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el \ - binario de un proyecto PageTop.\ +description = """ + Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el + binario de un proyecto PageTop. """ categories = ["development-tools::build-utils", "web-programming"] keywords = ["pagetop", "build", "assets", "resources", "static"] diff --git a/helpers/pagetop-build/README.md b/helpers/pagetop-build/README.md index 9f912e9..27c9814 100644 --- a/helpers/pagetop-build/README.md +++ b/helpers/pagetop-build/README.md @@ -5,6 +5,9 @@

Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el binario de un proyecto PageTop.

[![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](#-license) +[![Doc API](https://img.shields.io/docsrs/pagetop-build?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-build) +[![Crates.io](https://img.shields.io/crates/v/pagetop-build.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-build) +[![Descargas](https://img.shields.io/crates/d/pagetop-build.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-build) diff --git a/helpers/pagetop-build/src/lib.rs b/helpers/pagetop-build/src/lib.rs index b18cf52..90898dd 100644 --- a/helpers/pagetop-build/src/lib.rs +++ b/helpers/pagetop-build/src/lib.rs @@ -5,6 +5,9 @@ //!

Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el binario de un proyecto PageTop.

//! //! [![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](#-license) +//! [![Doc API](https://img.shields.io/docsrs/pagetop-build?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-build) +//! [![Crates.io](https://img.shields.io/crates/v/pagetop-build.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-build) +//! [![Descargas](https://img.shields.io/crates/d/pagetop-build.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-build) //! //! //! diff --git a/helpers/pagetop-macros/Cargo.toml b/helpers/pagetop-macros/Cargo.toml index 3a7fd95..27325b8 100644 --- a/helpers/pagetop-macros/Cargo.toml +++ b/helpers/pagetop-macros/Cargo.toml @@ -1,10 +1,10 @@ [package] name = "pagetop-macros" -version = "0.0.5" +version = "0.0.18" edition = "2021" -description = """\ - Una colección de macros que mejoran la experiencia de desarrollo con PageTop.\ +description = """ + Una colección de macros que mejoran la experiencia de desarrollo con PageTop. """ categories = ["development-tools::procedural-macro-helpers", "web-programming"] keywords = ["pagetop", "macros", "proc-macros", "codegen"] diff --git a/helpers/pagetop-macros/README.md b/helpers/pagetop-macros/README.md index e41dd0e..826698a 100644 --- a/helpers/pagetop-macros/README.md +++ b/helpers/pagetop-macros/README.md @@ -5,6 +5,9 @@

Una colección de macros que mejoran la experiencia de desarrollo con PageTop.

[![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](#-license) +[![Doc API](https://img.shields.io/docsrs/pagetop-macros?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-macros) +[![Crates.io](https://img.shields.io/crates/v/pagetop-macros.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-macros) +[![Descargas](https://img.shields.io/crates/d/pagetop-macros.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-macros) diff --git a/helpers/pagetop-macros/src/lib.rs b/helpers/pagetop-macros/src/lib.rs index b9be0be..8a6b98b 100644 --- a/helpers/pagetop-macros/src/lib.rs +++ b/helpers/pagetop-macros/src/lib.rs @@ -5,6 +5,9 @@ //!

Una colección de macros que mejoran la experiencia de desarrollo con PageTop.

//! //! [![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](#-license) +//! [![Doc API](https://img.shields.io/docsrs/pagetop-macros?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-macros) +//! [![Crates.io](https://img.shields.io/crates/v/pagetop-macros.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-macros) +//! [![Descargas](https://img.shields.io/crates/d/pagetop-macros.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-macros) //! //! //! diff --git a/src/lib.rs b/src/lib.rs index 598c55e..c0e28d4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,13 +7,26 @@ //!

Un entorno de desarrollo para crear soluciones web modulares, extensibles y configurables.

//! //! [![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](#-license) +//! [![Doc API](https://img.shields.io/docsrs/pagetop?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop) +//! [![Crates.io](https://img.shields.io/crates/v/pagetop.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop) +//! [![Descargas](https://img.shields.io/crates/d/pagetop.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop) //! //!
//! //! //! `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. +//! 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 //! @@ -27,6 +40,47 @@ //! Application::new().run()?.await //! } //! ``` +//! +//! Este código arranca el servidor de `PageTop` que, con la +//! [configuración por defecto](crate::global::SETTINGS), muestra una página de bienvenida accesible +//! desde un navegador local en `http://localhost:8080`. +//! +//! Para personalizar el servicio, se puede crear una extensión de `PageTop` de la siguiente manera: +//! +//! ```rust,no_run +//! 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 { +//! 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 `

`. +//! +//! # 🧩 Gestión de Dependencias +//! +//! Los proyectos que utilizan `PageTop` gestionan las dependencias con `cargo`, como cualquier otro +//! proyecto en Rust. +//! +//! Sin embargo, es fundamental que cada extensión declare explícitamente sus +//! [dependencias](core::extension::Extension::dependencies), si las tiene, para que `PageTop` pueda +//! estructurar e inicializar la aplicación de forma modular. #![cfg_attr(docsrs, feature(doc_cfg))] #![doc(