Merge pull request #223 from rakutentech/feature/prepare-a-demo

Demo on gh-pages

Author: kevincobain2000

.github/workflows/node.yml

@@ -10,13 +10,13 @@ jobs:
 
     strategy:
       matrix:
-        node-versions: [16, 18, 19]
+        node-versions: [16, 18, 19, 20]
 
     steps:
       - name: Cancel Previous Runs
         uses: styfle/[email protected]
         with:
-          access_token: ${{ github.token }}    
+          access_token: ${{ github.token }}
       - name: Checkout
         uses: actions/checkout@v2
 

.github/workflows/releaser.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Cancel Previous Runs
         uses: styfle/[email protected]
         with:
-          access_token: ${{ github.token }}    
+          access_token: ${{ github.token }}
       - name: Checkout
         uses: actions/checkout@v3
         with:
@@ -33,17 +33,33 @@ jobs:
         working-directory: ./ui
         run: npm install
 
-      - name: Lint, build/export
+      - name: Lint
         working-directory: ./ui
         run: |
           npm run lint
+
+      - name: Export dist to resources for Laravel
+        working-directory: ./ui
+        run: |
           npm run export
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:
           commit-message: (action) Update dist
-          title: '(action) update dist astro'
+          title: "(action) update dist astro"
 
+      - name: Export dist to resources for gh-pages
+        working-directory: ./ui
+        run: |
+          PUBLIC_BASE=laravel-request-docs npm run export
 
+      - name: .nojekyll
+        run: touch ./resources/dist/.nojekyll
 
+      - name: Deploy Demo
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./resources/dist
+          publish_branch: gh-pages

README.md

@@ -6,7 +6,7 @@
 
 <p align="center">
   The Hassle-Free automatic API documentation generation for Laravel. <br>
-  A Swagger alernative. <br>
+  A Swagger alternative. <br>
   Supports Open API 3.0.0
 </p>
 
@@ -19,13 +19,13 @@
   <a href="LICENSE.md"><img src="https://poser.pugx.org/rakutentech/laravel-request-docs/license.png" alt="License"></a>
 </p>
 
-**Fast:** Install on any Laravel Project
+**Fast** Install on any Laravel Project
 
-**Hassle Free:** Auto Generate API Documentation for request rules and parameters
+**Hassle Free** Auto Generate API Documentation for request rules and parameters
 
-**Analyze:** In built SQL query time analyzer, response time and headers output.
+**Analyze** Inbuilt SQL query time analyzer, response time and headers output.
 
-**Supports:** Postman and OpenAPI 3.0.0 exports.
+**Supports** Postman and OpenAPI 3.0.0 exports.
 
 ## Features
 
@@ -41,11 +41,11 @@
 - Display extra documentation using markdown
 - Saves history previous requests
 - Added filters to sort, group and filter routes by methods, controllers, middlewares, routes
-- Export laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0
+- Export Laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0
 
 # Read on Medium
 
-Automatically generate api documentation for Laravel without writing annotations.
+Automatically generate API documentation for Laravel without writing annotations.
 
 Read more: https://medium.com/web-developer/laravel-automatically-generate-api-documentation-without-annotations-a-swagger-alternative-e0699409a59e
 
@@ -72,7 +72,7 @@ php artisan vendor:publish --tag=request-docs-config
 php artisan route:cache
 ```
 
-(optional) Add following middleware to your API, so that the sql logs, model events are captured.
+(optional) Add the following middleware to your API, so that the SQL logs and model events are captured.
 
 `app/Http/Kernel.php`
 
@@ -92,7 +92,7 @@ View in the browser on ``/request-docs/``
 
 # Design pattern
 
-In order for this plugin to work, you need to follow the design pattern by injecting the request class inside the controller.
+For this plugin to work, you need to follow the design pattern by injecting the request class inside the controller.
 For extra documentation you can use markdown inside your controller method as well.
 
 ![Design pattern](https://imgur.com/yXjq3jp.png)
@@ -107,8 +107,8 @@ For extra documentation you can use markdown inside your controller method as we
 </p>
 
 
-- Uses localstorage to save history of previous requests and request headers.
-- Request, sql, response and events timeline below:
+- Uses local storage to save the history of previous requests and request headers.
+- Request, SQL, response and events timeline below:
 
 <p float="left">
   <img src="https://imgur.com/fd09jw1.png" width="32%" />
@@ -131,7 +131,7 @@ For extra documentation you can use markdown inside your controller method as we
 # Extra
 
 You write extra documentation in markdown which will be rendered as HTML on the dashboard.
-Example of using it in controller
+Example of using it in the controller
 
 ```php
     /**
@@ -146,7 +146,7 @@ Example of using it in controller
 
 # Params not in rules
 
-You write extra params with rules with @LRDparam in comment line as one line
+You write extra params with rules with @LRDparam in the comment line as one line
 
 ```php
     /**
@@ -188,29 +188,29 @@ Fixing lints
 - Initial Release
 - v1.9 Added improvements such as status code, response headers, custom request headers and fixed issues reported by users
 - v1.10 Show PHP memory usage, gzip encoding fix
-- v1.12 Bug Fix of id, and Laravel 9 support
+- v1.12 Bug fix of id, and Laravel 9 support
 - v1.13 Laravel 9 support
 - v1.15 Adds Filter and fall back to regexp upon Exception
-- v1.17 Donot restrict to FormRequest
-- v1.18 Fix where prism had fixed height. Allow text area resize.
+- v1.17 Do not restrict to FormRequest
+- v1.18 Fix where prism had fixed height. Allow the text area resize.
 - v1.18 Updated UI and pushed unit tests
 - v1.19 Exception -> Throwable for type error
 - v1.20 Feature support open api 3.0.0 #10
-- v1.21 Abililty to add custom params
+- v1.21 Ability to add custom params
 - v1.22 Boolean|File|Image support
 - v1.22 Boolean|File|Image support
-- v1.23 Bug fix for lrd doc block #76
+- v1.23 Bug fix for LRD doc block #76
 - v1.27 A few fixes on width and added request_methods
-- v2.0 UI Renewal to React static
+- v2.0 UI Renewal to React Static
     - `@QAParam` is now `@LRDparam`
     - No special changes for users, upgrade to v2.x as usual
     - Upgrading users will need to republish config
-- v2.1 UI - adds search bar and few aligment fixes on table
+- v2.1 UI - adds search bar and few alignment fixes on table
 - v2.2 PHP 8.1 and 8.2 support added
        - Groupby enabled for routes and controllers
-- v2.3 Bug fix for localstorage (tabs) and full UI refactored after alpha
+- v2.3 Bug fix for local storage (tabs) and full UI refactored after alpha
 - v2.4 Show version on navbar and curl is using ace editor
-- v2.5 Groupby final fix and localstorage clear button. Other UI refactor
+- v2.5 Groupby final fix and local storage clear button. Other UI refactor
 - v2.6 File uploads
 - v2.7 Show activity on Eloquent models
 - v2.8 Show full activity on Eloquent models

ui/astro.config.mjs

@@ -16,5 +16,5 @@ export default defineConfig({
     react()
   ],
   outDir: '../resources/dist',
-  base: '/request-docs',
+  base: process.env.PUBLIC_BASE || '/request-docs',
 });