Merge pull request #32 from visto9259/master

Update layout
LM-Commons · Nov 8, 2024 · 80cce90 · 80cce90
2 parents 1bcd04b + 036fa82
commit 80cce90
Show file tree

Hide file tree

Showing 30 changed files with 2,067 additions and 1,042 deletions.
diff --git a/docs/Components/administration.md b/docs/Components/administration.md
@@ -0,0 +1,31 @@
+---
+sidebar_position: 4
+title: Administration
+---
+
+## [LmcAdmin](https://lm-commons.github.io/LmcAdmin)
+
+LmcAdmin is a low-level module that helps Laminas MVC Framework developers  
+create admin interfaces. 
+
+The module allows to have a uniform layout, navigation structure and routing scheme. You can create controllers routed
+as a child of LmcAdmin, so you can easily change the (root) url, access control and other properties. 
+
+The navigation is also flexible, to allow you having a structure built of pages in the admin interface with menus, 
+breadcrumbs and other links.
+
+![Latest Stable Version](https://poser.pugx.org/lm-commons/lmc-admin/v/stable)
+![Total Downloads](http://poser.pugx.org/lm-commons/lmc-admin/downloads)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmcadmin%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+
+
+[Documentation](https://lm-commons.github.io/LmcAdmin)
+
+## LmcAdminUser (future)
+
+LmcAdmin submodule for user management
+
+## LmcAdminRbac (future)
+
+LmcAdmin submodule for roles and permissions management
diff --git a/docs/Components/cors.md b/docs/Components/cors.md
@@ -0,0 +1,16 @@
+---
+sidebar_position: 3
+title: Cross Origin Resource Sharing
+---
+
+## [LmcCors](https://lm-commons.github.io/LmcCors)
+LmcCors is a simple Laminas MVC module that 
+provides support to handle Cross-Origin Resource Sharing (CORS).
+
+![Latest Stable Version](https://poser.pugx.org/lm-commons/lmc-cors/v)
+![Total Downloads](https://poser.pugx.org/lm-commons/lmc-cors/downloads)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmccors%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+
+[Documentation](https://lm-commons.github.io/LmcCors)
+
diff --git a/docs/Components/introduction.md b/docs/Components/introduction.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+LM-Commons is a GitHub organization dedicated to the collaborative
+and community-driven long-term maintenance of packages & libraries based on the Laminas MVC and Components, and on 
+Mezzio.
diff --git a/docs/Components/roles-permissions.md b/docs/Components/roles-permissions.md
@@ -0,0 +1,40 @@
+---
+sidebar_position: 2
+title: Roles and Permissions
+---
+
+LM-Commons provides components to add roles and permissions to your application.
+
+## [LmcRbac](https://lm-commons.github.io/LmcRbac)
+LmcRbac provides the authorization services to implement role-based access control on top of 
+Laminas\Permissions\Rbac.
+
+Roles and permissions can be defined in simple local configuration file, suitable for applications with
+a small set of roles and permissions, or in database for application with larger sets of roles and permissions.
+
+![Version](https://poser.pugx.org/lm-commons/lmc-rbac/v)
+![Total Downloads](https://poser.pugx.org/lm-commons/lmc-rbac/downloads)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmcrbac%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+[Documentation](https://lm-commons.github.io/LmcRbac)
+
+## [LmcRbacMvc](https://lm-commons.github.io/LmcRbacMvc)
+
+LmcRbacMvc is a companion component that extends the functionality 
+of LmcRbac to provide Role-based Access Control (RBAC) for Laminas MVC applications.
+
+LmcRbacMvc provides:
+- Route and controller guard to control access to route based on roles.
+- Strategies to handle unauthorized access, such as 403 response and redirection
+- Controller and view authorization plugins
+
+![Version](https://poser.pugx.org/lm-commons/lmc-rbac-mvc/version)
+![Total Downloads](https://poser.pugx.org/lm-commons/lmc-rbac-mvc/downloads)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmcrbacmvc%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+[Documentation](https://lm-commons.github.io/LmcRbacMvc)
+
+## LmcRbacMezzio (future)
+
+LmcRbacMezzio will be a companion component that extends the functionality
+of LmcRbac to provide Role-based Access Control (RBAC) for Mezzio applications.
diff --git a/docs/Components/user-management.md b/docs/Components/user-management.md
@@ -0,0 +1,17 @@
+---
+sidebar_position: 1
+title: User Management
+---
+
+## [LmcUser](https://lm-commons.github.io/LmcUser)
+LmcUser is a user registration and authentication module for Laminas MVC.
+LmcUser provides the foundations for adding
+user authentication and registration to your Laminas MVC application. It is designed to be very
+simple and easy to extend.
+
+![Latest Stable Version](http://poser.pugx.org/lm-commons/lmc-user/v)
+![Total Downloads](http://poser.pugx.org/lm-commons/lmc-user/downloads)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmcrbacmvc%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+
+[Documentation](https://lm-commons.github.io/LmcUser)
diff --git a/docs/Components/utilities.md b/docs/Components/utilities.md
@@ -0,0 +1,16 @@
+---
+sidebar_position: 5
+title: Utilities
+---
+
+## [LmcMail](https://lm-commons.github.io/LmcMail)
+
+LmcMail is an email service module that provides the ability to use the View Manager of a Laminas MVC application
+and the installed View Helper plugins to render HTML emails.
+
+![Version](https://poser.pugx.org/lm-commons/lmc-mail/v)
+![Total Downloads](https://poser.pugx.org/lm-commons/lmc-mail/downloads)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmcmail%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
+
+
+[Documentation](https://lm-commons.github.io/LmcMail)
diff --git a/docs/StarterKits/introduction.md b/docs/StarterKits/introduction.md
@@ -0,0 +1,10 @@
+---
+title: Introduction
+sidebar_position: 1
+---
+
+The intent of the LM-Commons Starter Kits is to provide skeletons, either based on Laminas MVC or on Laminas Mezzio,
+that meet business needs above the basic MVC and Mezzio frameworks by including user management, role based access, CORS
+and administration modules.
+
+This is a work in progress looking for contributors.
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -5,7 +5,5 @@ sidebar_position: 1
 # Introduction
 
 LM-Commons is a GitHub organization dedicated to the collaborative
-and community-driven long-term maintenance of packages & libraries based on the Laminas MVC and Components.
-
-Many of the packages found in the LM-Commons repositories are former ZF-Commons packages
-that were migrated to the Laminas Project framework.
+and community-driven long-term maintenance of packages & libraries based on the Laminas MVC and Components, and on 
+Mezzio.
diff --git a/docs/packages/LmcAdmin.md b/docs/packages/LmcAdmin.md
diff --git a/docs/packages/LmcCors.md b/docs/packages/LmcCors.md
diff --git a/docs/packages/LmcMail.md b/docs/packages/LmcMail.md
diff --git a/docs/packages/LmcRbac.md b/docs/packages/LmcRbac.md
diff --git a/docs/packages/LmcRbacMvc.md b/docs/packages/LmcRbacMvc.md
diff --git a/docs/packages/LmcUser.md b/docs/packages/LmcUser.md
diff --git a/docs/packages/_category_.json b/docs/packages/_category_.json
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -8,8 +8,8 @@ import {themes as prismThemes} from 'prism-react-renderer';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'LM Commons',
-  tagline: 'Community developed packages for Laminas MVC and Mezzio',
+  title: 'LM-Commons',
+  tagline: 'Community developed components and starter kits for Laminas MVC and Mezzio',
   favicon: 'img/favicon.ico',
 
   // Set the production url of your site here
@@ -50,6 +50,7 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl: 'https://github.com/lm-commons/tree/master/',
+          onUntruncatedBlogPosts: 'ignore',
         },
         theme: {
           customCss: './src/css/custom.css',
@@ -63,6 +64,19 @@ const config = {
     ({
       // Replace with your project's social card
       image: 'img/LMC-social-card.jpg',
+      colorMode: {
+        disableSwitch: true,
+        defaultMode: 'light'
+      },
+      /*
+      announcementBar: {
+        id: 'new_version_lmcrbac',
+        content: "<h1 style='font-size: 120%'><strong>New versions of LmcRbac and LmcRbacMvc are available</strong></h1>",
+        isCloseable: false,
+        //backgroundColor: 'lightgray'
+      },
+
+       */
       navbar: {
         title: 'LM-Commons',
         logo: {
@@ -72,18 +86,25 @@ const config = {
         items: [
           {
             type: 'docSidebar',
-            sidebarId: 'mainSidebar',
+            sidebarId: 'components',
+            position: 'left',
+            label: 'Components',
+          },
+          {
+            type: 'docSidebar',
+            sidebarId: 'starterKits',
             position: 'left',
-            label: 'Docs',
+            label: 'Starter Kits',
           },
           {
             to: '/blog',
             label: 'Blog',
-            position: 'left'
+            position: 'right'
           },
+          /*
           {
             type: 'dropdown',
-            label: 'Packages',
+            label: 'Components',
             items: [
               {
                 href: 'https://lm-commons.github.io/LmcCors/',
@@ -111,11 +132,13 @@ const config = {
               },
             ]
           },
+
+           */
           {
             href: 'https://github.com/lm-commons',
-            label: 'GitHub',
+            //label: 'GitHub',
             position: 'right',
-          },
+            className: 'header-github-link',          },
         ],
       },
       footer: {
@@ -149,11 +172,18 @@ const config = {
               {
                 label: 'Disclaimer',
                 to: 'disclaimer',
-              }
+              },
+              /*
+              {
+                label: 'Privacy',
+                to: 'privacy',
+              },
+
+               */
             ],
           }
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} LM-Commons Organization. Built with Docusaurus.`,
+        copyright: `Copyright © ${new Date().getFullYear()} LM-Commons Organization.<br><span style="font-size:75%">Built with Docusaurus</span>`,
       },
       prism: {
         theme: prismThemes.github,

diff --git a/package.json b/package.json
@@ -14,17 +14,17 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.4.0",
-    "@docusaurus/preset-classic": "3.4.0",
+    "@docusaurus/core": "^3.6.1",
+    "@docusaurus/preset-classic": "^3.6.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.4.0",
-    "@docusaurus/types": "3.4.0"
+    "@docusaurus/module-type-aliases": "^3.6.1",
+    "@docusaurus/types": "^3.6.1"
   },
   "browserslist": {
     "production": [

diff --git a/sidebars.js b/sidebars.js
@@ -15,12 +15,8 @@
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
   mainSidebar: [{type: 'autogenerated', dirName: '.'}],
-  packages: [{type: "autogenerated", dirName: 'packages'}],
-//  lmcRbacMvc: [{type: 'autogenerated', dirName: 'lmc-rbac-mvc'}],
-//  lmcUser: [{type: 'autogenerated', dirName: 'lmc-user'}],
-//  lmcCors: [{type: 'autogenerated', dirName: 'lmc-cors'}],
-//  lmcRbac: [{type: 'autogenerated', dirName: 'lmc-rbac'}],
-//  lmcMail: [{type: 'autogenerated', dirName: 'lmc-mail'}],
+  components: [{type: "autogenerated", dirName: 'Components'}],
+  starterKits: [{type: 'autogenerated', dirName: 'StarterKits'}],
 
   // But you can create a sidebar manually
 /*

diff --git a/src/components/HomepageFeatures/PackageCard.js b/src/components/HomepageFeatures/PackageCard.js
@@ -6,18 +6,18 @@ import Link from "@docusaurus/core/lib/client/exports/Link";
 export function PackageCard({title, description, href}) {
   return (
     <div className={clsx('card-demo col col--4 margin-bottom--md')}>
-      <div className="card shadow--md ">
+      <div className="card shadow--tl">
         <div className="card__header text--center">
           <Heading as='h3'>{title}</Heading>
         </div>
-        <div className="card__body">
+        <div className={clsx('card__body')}>
           <p>
             {description}
           </p>
         </div>
-        <div className="card__footer">
+        <div className={clsx('card__footer')}>
           <div className={styles.buttons}>
-            <Link className="button button--primary" to={href}>Documentation</Link>
+            <Link className={clsx('button button--primary')} to={href}>Get started</Link>
           </div>
         </div>
       </div>