🚧 Normalize Cargo and README files

This commit is contained in:
Manuel Cillero 2024-03-23 21:21:43 +01:00
parent 8d2fc7e9e6
commit 2ea0a1698e
19 changed files with 221 additions and 120 deletions

View file

@ -3,24 +3,22 @@ name = "pagetop"
version = "0.0.52"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
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"

View file

@ -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)
<br>
</div>
## 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.

View file

@ -3,16 +3,15 @@ name = "drust"
version = "0.0.3"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
[dependencies]
pagetop = { version = "0.0", path = "../", features = ["mysql"], default-features = false }
# Packages.

View file

@ -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.
<div align="center">
<h1>Drust</h1>
<p>A Content Management System built on PageTop.</p>
</div>
[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.

View file

@ -3,16 +3,20 @@ name = "pagetop-build"
version = "0.0.9"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
categories = [
"development-tools::build-utils", "web-programming"
]
keywords = [
"pagetop", "build", "assets", "resources", "static"
]
[dependencies]
static-files = "0.2.3"

View file

@ -1,6 +1,15 @@
Simplifies the process of embedding resources directly into binary files for **PageTop**
applications.
<div align="center">
<h1>PageTop Build</h1>
<p>Simplifies the process of embedding resources in PageTop app binaries.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -3,16 +3,21 @@ name = "pagetop-macros"
version = "0.0.11"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
categories = [
"development-tools::procedural-macro-helpers", "web-programming"
]
keywords = [
"pagetop", "macros", "proc-macros", "codegen"
]
[lib]
proc-macro = true

View file

@ -1,5 +1,15 @@
A collection of procedural macros that enhance the development experience within **PageTop**.
<div align="center">
<h1>PageTop Macros</h1>
<p>A collection of procedural macros that boost PageTop development.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -3,16 +3,20 @@ name = "pagetop-admin"
version = "0.0.20"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
categories = [
"web-programming", "gui"
]
keywords = [
"pagetop", "admin", "config", "settings", "packages"
]
[dependencies]
pagetop = { version = "0.0", path = "../../" }

View file

@ -1,6 +1,15 @@
**PageTop** package that provides a unified interface for administrators to configure and manage
package settings.
<div align="center">
<h1>PageTop Admin</h1>
<p>PageTop package that provides a unified settings interface to other packages.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -3,17 +3,21 @@ name = "pagetop-bootsier"
version = "0.0.17"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
categories = [
"web-programming", "gui"
]
keywords = [
"pagetop", "theme", "bootstrap", "css", "js"
]
[dependencies]
pagetop = { version = "0.0", path = "../../" }
static-files = "0.2.3"

View file

@ -1,6 +1,15 @@
**PageTop** theme that utilizes the [Bootstrap](https://getbootstrap.com/) framework to offer
versatile page layouts and component stylings.
<div align="center">
<h1>PageTop Bootsier</h1>
<p>PageTop theme that uses Bootstrap framework for versatile styles and components.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -3,16 +3,21 @@ name = "pagetop-bulmix"
version = "0.0.16"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
categories = [
"web-programming", "gui"
]
keywords = [
"pagetop", "theme", "bulma", "css", "js"
]
[dependencies]
pagetop = { version = "0.0", path = "../../" }
static-files = "0.2.3"

View file

@ -1,6 +1,15 @@
**PageTop** theme that utilizes the [Bulma](https://bulma.io/) framework for sleek, responsive
design elements.
<div align="center">
<h1>PageTop Bulmix</h1>
<p>PageTop theme that uses the Bulma framework for sleek, responsive design elements.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -3,16 +3,20 @@ name = "pagetop-node"
version = "0.0.19"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
categories = [
"web-programming", "gui"
]
keywords = [
"pagetop", "node", "cms", "content", "workflow"
]
[dependencies]
pagetop = { version = "0.0", path = "../../", features = ["database"], default-features = false }

View file

@ -1,6 +1,15 @@
**PageTop** package that enables the creation and customization of content types, enhancing website
content management.
<div align="center">
<h1>PageTop Node</h1>
<p>PageTop package for easy content type creation and customization.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -3,17 +3,21 @@ name = "pagetop-user"
version = "0.0.18"
edition = "2021"
authors = [
"Manuel Cillero <manuel@cillero.es>"
]
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 <manuel@cillero.es>"
]
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"] }

View file

@ -1,6 +1,15 @@
Facilitates user management, including roles, permissions, and session handling, for applications
built on **PageTop**.
<div align="center">
<h1>PageTop User</h1>
<p>PageTop package for user, roles, permissions, and session management.</p>
[![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)
</div>
# 📦 About PageTop

View file

@ -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
//!