diff --git a/Cargo.toml b/Cargo.toml index a99b3fd3..22e2112a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,24 +3,22 @@ name = "pagetop" version = "0.0.52" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - An opinionated web framework to build modular Server-Side Rendering web solutions. -""" +description = "An opinionated web framework to build modular Server-Side Rendering web solutions." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] categories = [ - "web-programming", "development-tools", "gui" + "web-programming", "gui", "development-tools", "asynchronous" ] keywords = [ - "web", "framework", "frontend", "ssr", "pagetop" + "pagetop", "web", "framework", "frontend", "ssr" ] exclude = [ - "drust/", "examples/", "helpers/", "packages/", "tests/", "workdir/" + "drust/", "examples/", "helpers/", "packages/", "tests/" ] rust-version = "1.70.0" diff --git a/README.md b/README.md index ff9b7f22..14523297 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,21 @@ [![Crates.io](https://img.shields.io/crates/v/pagetop.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop) [![Downloads](https://img.shields.io/crates/d/pagetop.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop) -
+## Overview + The PageTop core API provides a comprehensive toolkit for extending its functionalities to specific requirements and application scenarios through actions, components, packages, and themes: -* **Actions** serve as a mechanism to customize PageTop's internal behavior by intercepting its - execution flow. -* **Components** encapsulate HTML, CSS, and JavaScript into functional, configurable, and - well-defined units. -* **Packages** extend or customize existing functionality by interacting with PageTop APIs or - third-party package APIs. -* **Themes** enable developers to alter the appearance of pages and components without affecting - their functionality. + * **Actions** serve as a mechanism to customize PageTop's internal behavior by intercepting its + execution flow. + * **Components** encapsulate HTML, CSS, and JavaScript into functional, configurable, and + well-defined units. + * **Packages** extend or customize existing functionality by interacting with PageTop APIs or + third-party package APIs. + * **Themes** enable developers to alter the appearance of pages and components without affecting + their functionality. # ⚡️ Quick start @@ -63,38 +64,38 @@ distinct role within the PageTop ecosystem: ## Application -* [drust](https://github.com/manuelcillero/pagetop/tree/main/drust): +* [drust](https://github.com/manuelcillero/pagetop/tree/latest/drust): A simple Content Management System (CMS) built on PageTop, which enables the creation, editing, and maintenance of dynamic, fast, and modular websites. It uses the following essential packages to provide standard CMS functionalities. ## Helpers -* [pagetop-macros](https://github.com/manuelcillero/pagetop/tree/main/helpers/pagetop-macros): +* [pagetop-macros](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-macros): A collection of procedural macros that enhance the development experience within PageTop. -* [pagetop-build](https://github.com/manuelcillero/pagetop/tree/main/helpers/pagetop-build): +* [pagetop-build](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-build): Simplifies the process of embedding resources directly into binary files for PageTop applications. ## Packages -* [pagetop-user](https://github.com/manuelcillero/pagetop/tree/main/packages/pagetop-user): +* [pagetop-user](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-user): Facilitates user management, including roles, permissions, and session handling, for applications built on PageTop. -* [pagetop-admin](https://github.com/manuelcillero/pagetop/tree/main/packages/pagetop-admin): +* [pagetop-admin](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-admin): Provides a unified interface for administrators to configure and manage package settings. -* [pagetop-node](https://github.com/manuelcillero/pagetop/tree/main/packages/pagetop-node): +* [pagetop-node](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-node): Enables the creation and customization of content types, enhancing website content management. ## Themes -* [pagetop-bootsier](https://github.com/manuelcillero/pagetop/tree/main/packages/pagetop-bootsier): +* [pagetop-bootsier](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-bootsier): Utilizes the *[Bootstrap](https://getbootstrap.com/)* framework to offer versatile page layouts and component stylings. -* [pagetop-bulmix](https://github.com/manuelcillero/pagetop/tree/main/packages/pagetop-bulmix): +* [pagetop-bulmix](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-bulmix): Utilizes the *[Bulma](https://bulma.io/)* framework for sleek, responsive design elements. diff --git a/drust/Cargo.toml b/drust/Cargo.toml index 9d3c48e1..68baf623 100644 --- a/drust/Cargo.toml +++ b/drust/Cargo.toml @@ -3,16 +3,15 @@ name = "drust" version = "0.0.3" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - A modern web Content Management System to share your world.\ -""" +description = "A modern web Content Management System to share your world." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] + [dependencies] pagetop = { version = "0.0", path = "../", features = ["mysql"], default-features = false } # Packages. diff --git a/drust/README.md b/drust/README.md index 25431d18..0901a3da 100644 --- a/drust/README.md +++ b/drust/README.md @@ -1,28 +1,37 @@ -**Drust** es una aplicación inspirada modestamente en [Drupal](https://www.drupal.org) que utiliza -**PageTop** para crear un CMS (*Content Management System* o sistema de gestión de contenidos) para -construir sitios web dinámicos, administrados y configurables. +
+

Drust

+

A Content Management System built on PageTop.

+
-[PageTop](https://github.com/manuelcillero/pagetop/tree/main/pagetop), es un entorno de desarrollo -basado en algunos de los *crates* más estables y populares del ecosistema Rust para proporcionar -APIs, patrones de desarrollo y buenas prácticas para la creación de soluciones web SSR (*Server-Side -Rendering*). +## Overview + +Modestly inspired by [Drupal](https://www.drupal.org), **Drust** utilizes **PageTop** to develop a +CMS (*Content Management System*). It enables the creation of dynamic, manageable, and customizable +websites, allowing users to effortlessly create, manage, and organize a wide variety of content on a +website. -# 🚧 Advertencia +# 📦 About PageTop -**PageTop** sólo libera actualmente versiones de desarrollo. La API no es estable y los cambios son -constantes. No puede considerarse preparado hasta que se libere la versión **0.1.0**. +[PageTop](https://docs.rs/pagetop) is an opinionated web framework to build modular *Server-Side +Rendering* web solutions. -# 📜 Licencia +# 🚧 Warning -Este proyecto tiene licencia, de hecho tiene dos, puedes aplicar cualquiera de las siguientes a tu -elección: +**PageTop** framework is currently in active development. The API is unstable and subject to +frequent changes. Production use is not recommended until version **0.1.0**. -* Licencia Apache versión 2.0 - ([LICENSE-APACHE](https://github.com/manuelcillero/pagetop/blob/main/LICENSE-APACHE) o - [http://www.apache.org/licenses/LICENSE-2.0]). -* Licencia MIT - ([LICENSE-MIT](https://github.com/manuelcillero/pagetop/blob/main/LICENSE-MIT) o - [http://opensource.org/licenses/MIT]). +# 📜 License + +All code in this project is dual-licensed under either: + + * MIT License + ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT) + + * Apache License, Version 2.0, + ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0) + +at your option. This means you can select the license you prefer! This dual-licensing approach is +the de-facto standard in the Rust ecosystem. diff --git a/helpers/pagetop-build/Cargo.toml b/helpers/pagetop-build/Cargo.toml index ba89e653..bea69f29 100644 --- a/helpers/pagetop-build/Cargo.toml +++ b/helpers/pagetop-build/Cargo.toml @@ -3,16 +3,20 @@ name = "pagetop-build" version = "0.0.9" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - Simplifies the process of embedding resources directly into binary files for PageTop \ - applications.\ -""" +description = "Simplifies the process of embedding resources in PageTop app binaries." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "development-tools::build-utils", "web-programming" +] +keywords = [ + "pagetop", "build", "assets", "resources", "static" +] + [dependencies] static-files = "0.2.3" diff --git a/helpers/pagetop-build/README.md b/helpers/pagetop-build/README.md index 2aa67df0..0e80b363 100644 --- a/helpers/pagetop-build/README.md +++ b/helpers/pagetop-build/README.md @@ -1,6 +1,15 @@ -Simplifies the process of embedding resources directly into binary files for **PageTop** -applications. +
+

PageTop Build

+ +

Simplifies the process of embedding resources in PageTop app binaries.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-build?label=API%20Docs&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) +[![Downloads](https://img.shields.io/crates/d/pagetop-build.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-build) + +
# 📦 About PageTop diff --git a/helpers/pagetop-macros/Cargo.toml b/helpers/pagetop-macros/Cargo.toml index eb81bcc7..00a03c7a 100644 --- a/helpers/pagetop-macros/Cargo.toml +++ b/helpers/pagetop-macros/Cargo.toml @@ -3,16 +3,21 @@ name = "pagetop-macros" version = "0.0.11" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - A collection of procedural macros that enhance the development experience within PageTop.\ -""" +description = "A collection of procedural macros that boost PageTop development." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "development-tools::procedural-macro-helpers", "web-programming" +] +keywords = [ + "pagetop", "macros", "proc-macros", "codegen" +] + [lib] proc-macro = true diff --git a/helpers/pagetop-macros/README.md b/helpers/pagetop-macros/README.md index d6879110..56fc5516 100644 --- a/helpers/pagetop-macros/README.md +++ b/helpers/pagetop-macros/README.md @@ -1,5 +1,15 @@ -A collection of procedural macros that enhance the development experience within **PageTop**. +
+

PageTop Macros

+ +

A collection of procedural macros that boost PageTop development.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-macros?label=API%20Docs&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) +[![Downloads](https://img.shields.io/crates/d/pagetop-macros.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-macros) + +
# 📦 About PageTop diff --git a/packages/pagetop-admin/Cargo.toml b/packages/pagetop-admin/Cargo.toml index aec1f308..abb96175 100644 --- a/packages/pagetop-admin/Cargo.toml +++ b/packages/pagetop-admin/Cargo.toml @@ -3,16 +3,20 @@ name = "pagetop-admin" version = "0.0.20" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - PageTop package that provides a unified interface for administrators to configure and manage \ - package settings.\ -""" +description = "PageTop package that provides a unified settings interface to other packages." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "web-programming", "gui" +] +keywords = [ + "pagetop", "admin", "config", "settings", "packages" +] + [dependencies] pagetop = { version = "0.0", path = "../../" } diff --git a/packages/pagetop-admin/README.md b/packages/pagetop-admin/README.md index 2815c5e0..d6bf416b 100644 --- a/packages/pagetop-admin/README.md +++ b/packages/pagetop-admin/README.md @@ -1,6 +1,15 @@ -**PageTop** package that provides a unified interface for administrators to configure and manage -package settings. +
+

PageTop Admin

+ +

PageTop package that provides a unified settings interface to other packages.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-admin?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-admin) +[![Crates.io](https://img.shields.io/crates/v/pagetop-admin.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-admin) +[![Downloads](https://img.shields.io/crates/d/pagetop-admin.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-admin) + +
# 📦 About PageTop diff --git a/packages/pagetop-bootsier/Cargo.toml b/packages/pagetop-bootsier/Cargo.toml index bbc72732..1561ce30 100644 --- a/packages/pagetop-bootsier/Cargo.toml +++ b/packages/pagetop-bootsier/Cargo.toml @@ -3,17 +3,21 @@ name = "pagetop-bootsier" version = "0.0.17" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - PageTop theme that utilizes the Bootstrap framework to offer versatile page layouts and \ - component stylings.\ -""" +description = "PageTop theme that uses Bootstrap framework for versatile styles and components." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "web-programming", "gui" +] +keywords = [ + "pagetop", "theme", "bootstrap", "css", "js" +] + [dependencies] pagetop = { version = "0.0", path = "../../" } static-files = "0.2.3" diff --git a/packages/pagetop-bootsier/README.md b/packages/pagetop-bootsier/README.md index 31d9a6fe..724f70eb 100644 --- a/packages/pagetop-bootsier/README.md +++ b/packages/pagetop-bootsier/README.md @@ -1,6 +1,15 @@ -**PageTop** theme that utilizes the [Bootstrap](https://getbootstrap.com/) framework to offer -versatile page layouts and component stylings. +
+

PageTop Bootsier

+ +

PageTop theme that uses Bootstrap framework for versatile styles and components.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-bootsier?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-bootsier) +[![Crates.io](https://img.shields.io/crates/v/pagetop-bootsier.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-bootsier) +[![Downloads](https://img.shields.io/crates/d/pagetop-bootsier.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-bootsier) + +
# 📦 About PageTop diff --git a/packages/pagetop-bulmix/Cargo.toml b/packages/pagetop-bulmix/Cargo.toml index f8370dc3..dd87ed6a 100644 --- a/packages/pagetop-bulmix/Cargo.toml +++ b/packages/pagetop-bulmix/Cargo.toml @@ -3,16 +3,21 @@ name = "pagetop-bulmix" version = "0.0.16" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - PageTop theme that utilizes the Bulma framework for sleek, responsive design elements.\ -""" +description = "PageTop theme that uses the Bulma framework for sleek, responsive design elements." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "web-programming", "gui" +] +keywords = [ + "pagetop", "theme", "bulma", "css", "js" +] + [dependencies] pagetop = { version = "0.0", path = "../../" } static-files = "0.2.3" diff --git a/packages/pagetop-bulmix/README.md b/packages/pagetop-bulmix/README.md index 1b365354..a1ac03c1 100644 --- a/packages/pagetop-bulmix/README.md +++ b/packages/pagetop-bulmix/README.md @@ -1,6 +1,15 @@ -**PageTop** theme that utilizes the [Bulma](https://bulma.io/) framework for sleek, responsive -design elements. +
+

PageTop Bulmix

+ +

PageTop theme that uses the Bulma framework for sleek, responsive design elements.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-bulmix?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-bulmix) +[![Crates.io](https://img.shields.io/crates/v/pagetop-bulmix.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-bulmix) +[![Downloads](https://img.shields.io/crates/d/pagetop-bulmix.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-bulmix) + +
# 📦 About PageTop diff --git a/packages/pagetop-node/Cargo.toml b/packages/pagetop-node/Cargo.toml index c82ea468..ab62ea9b 100644 --- a/packages/pagetop-node/Cargo.toml +++ b/packages/pagetop-node/Cargo.toml @@ -3,16 +3,20 @@ name = "pagetop-node" version = "0.0.19" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - PageTop package that enables the creation and customization of content types, enhancing \ - website content management.\ -""" +description = "PageTop package for easy content type creation and customization." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "web-programming", "gui" +] +keywords = [ + "pagetop", "node", "cms", "content", "workflow" +] + [dependencies] pagetop = { version = "0.0", path = "../../", features = ["database"], default-features = false } diff --git a/packages/pagetop-node/README.md b/packages/pagetop-node/README.md index 789a8498..7c7feea0 100644 --- a/packages/pagetop-node/README.md +++ b/packages/pagetop-node/README.md @@ -1,6 +1,15 @@ -**PageTop** package that enables the creation and customization of content types, enhancing website -content management. +
+

PageTop Node

+ +

PageTop package for easy content type creation and customization.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-node?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-node) +[![Crates.io](https://img.shields.io/crates/v/pagetop-node.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-node) +[![Downloads](https://img.shields.io/crates/d/pagetop-node.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-node) + +
# 📦 About PageTop diff --git a/packages/pagetop-user/Cargo.toml b/packages/pagetop-user/Cargo.toml index 8d6ae021..4f8ffa0e 100644 --- a/packages/pagetop-user/Cargo.toml +++ b/packages/pagetop-user/Cargo.toml @@ -3,17 +3,21 @@ name = "pagetop-user" version = "0.0.18" edition = "2021" -authors = [ - "Manuel Cillero " -] -description = """\ - Facilitates user management, including roles, permissions, and session handling, for \ - applications built on PageTop.\ -""" +description = "PageTop package for user, roles, permissions, and session management." homepage = "https://pagetop.cillero.es" repository = "https://github.com/manuelcillero/pagetop" license = "MIT OR Apache-2.0" +authors = [ + "Manuel Cillero " +] +categories = [ + "web-programming", "gui", "authentication" +] +keywords = [ + "pagetop", "user", "login", "grants", "preferences" +] + [dependencies] pagetop = { version = "0.0", path = "../../", features = ["database"], default-features = false } serde = { version = "1.0", features = ["derive"] } diff --git a/packages/pagetop-user/README.md b/packages/pagetop-user/README.md index 637741fd..22363ba5 100644 --- a/packages/pagetop-user/README.md +++ b/packages/pagetop-user/README.md @@ -1,6 +1,15 @@ -Facilitates user management, including roles, permissions, and session handling, for applications -built on **PageTop**. +
+

PageTop User

+ +

PageTop package for user, roles, permissions, and session management.

+ +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?style=for-the-badge)](#-license) +[![API Docs](https://img.shields.io/docsrs/pagetop-user?label=API%20Docs&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-user) +[![Crates.io](https://img.shields.io/crates/v/pagetop-user.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-user) +[![Downloads](https://img.shields.io/crates/d/pagetop-user.svg?style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-user) + +
# 📦 About PageTop diff --git a/src/lib.rs b/src/lib.rs index 12361d2b..af7ee6bd 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,14 +18,14 @@ //! specific requirements and application scenarios through actions, components, packages, and //! themes: //! -//! * **Actions** serve as a mechanism to customize PageTop's internal behavior by intercepting its -//! execution flow. -//! * **Components** encapsulate HTML, CSS, and JavaScript into functional, configurable, and -//! well-defined units. -//! * **Packages** extend or customize existing functionality by interacting with PageTop APIs or -//! third-party package APIs. -//! * **Themes** enable developers to alter the appearance of pages and components without affecting -//! their functionality. +//! * **Actions** serve as a mechanism to customize PageTop's internal behavior by intercepting +//! its execution flow. +//! * **Components** encapsulate HTML, CSS, and JavaScript into functional, configurable, and +//! well-defined units. +//! * **Packages** extend or customize existing functionality by interacting with PageTop APIs or +//! third-party package APIs. +//! * **Themes** enable developers to alter the appearance of pages and components without +//! affecting their functionality. //! //! # ⚡️ Quick start //! @@ -54,7 +54,7 @@ //! This program implements a package named `HelloWorld` with one service that returns a web page //! that greets the world whenever it is accessed from the browser at `http://localhost:8088` (using //! the [default configuration settings](`config::Server`)). You can find this code in the PageTop -//! [examples repository](https://github.com/manuelcillero/pagetop/tree/main/examples). +//! [examples repository](https://github.com/manuelcillero/pagetop/tree/latest/examples). //! //! # 🧩 Dependency Management //!