pagetop/README.md
2024-02-09 14:05:38 +01:00

3.9 KiB

PageTop

License API Docs Crates.io Downloads

PageTop is an opinionated Rust web development framework to build secure and modular Server-Side Rendering (SSR) web solutions.

PageTop stands on the shoulders of giants. It leverages some of the most stable and popular Rust crates to provide extensible and easily configurable features.

🚧 Warning

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.

📂 Repository Structure

This repository is organized into a workspace that includes several subprojects, each serving a distinct role within the PageTop ecosystem:

Application

  • drust, a simple Content Management System (CMS) built on PageTop, which enables the creation, editing, and maintenance of dynamic, fast, and secure websites. It uses the following essential packages to provide standard CMS functionalities.

Packages

  • pagetop-homedemo: Showcases a demo homepage, offering a glimpse into PageTop's capabilities.

  • pagetop-admin: Offers a unified interface for administrators to configure and manage package settings.

  • pagetop-user: Facilitates user management, including roles, permissions, and session handling, for PageTop-based applications.

  • pagetop-node: Enables the creation and customization of content types, enhancing website content management.

Themes

Helpers

  • pagetop-macros: A collection of procedural macros that enhance the development experience within PageTop.

  • pagetop-build: Simplifies the process of embedding resources directly into binary files for PageTop applications.

📜 License

PageTop is free, open source and permissively licensed! Except where noted (below and/or in individual files), all code in this repository is dual-licensed under either:

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.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.