Merge pull request #58 from arifszn/docs

Update docs

README.md

@@ -56,8 +56,6 @@
 
 **Pandora** is a modern, customized, feature-rich API starter kit to kickstart your next _REST_ API backend.
 
-⚠️ The status of this project is **WIP**.
-
 ## Features
 
 -   [Dockerized](https://arifszn.github.io/pandora/docs/installation#with-docker-sail)
@@ -70,6 +68,11 @@
 -   [Code Style & Lint](https://arifszn.github.io/pandora/docs/features/code-style-and-lint)
 -   [CI/CD](https://arifszn.github.io/pandora/docs/features/ci-cd)
 -   [Log Viewer](https://arifszn.github.io/pandora/docs/features/log-viewer)
+
+## Functionalities
+
+-   [Multi Auth](https://arifszn.github.io/pandora/docs/functionalities/authentication)
+
 <!-- -   REST API
 -   Multi auth
 -   Social Login

database/seeders/DatabaseSeeder.php

@@ -16,6 +16,7 @@ public function run()
     {
         $this->call([
             AdminSeeder::class,
+            UserSeeder::class,
         ]);
     }
 }

database/seeders/UserSeeder.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Database\Seeders;
+
+use App\Models\User;
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\Hash;
+
+class UserSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        User::create([
+            'name' => 'User',
+            'email' => '[email protected]',
+            'password' => Hash::make('123456'),
+        ]);
+    }
+}

public/openapi.yaml

@@ -81,7 +81,7 @@ paths:
   /api/admin/login:
     post:
       tags:
-        - auth
+        - adminAuth
       summary: 'Login an admin.'
       operationId: AuthController.adminLogin
       requestBody:
@@ -251,3 +251,6 @@ tags:
   -
     name: auth
     description: 'User authentication'
+  -
+    name: adminAuth
+    description: 'Admin authentication'

website/docs/1-introduction.md

@@ -49,8 +49,6 @@ hide_title: true
 
 **Pandora** is a modern, customized, feature-rich API starter kit to kickstart your next _REST_ API backend.
 
-⚠️ The status of this project is **WIP**.
-
 ## Features
 
 - [Dockerized](/docs/installation#with-docker-sail)
@@ -64,6 +62,10 @@ hide_title: true
 - [CI/CD](/docs/features/ci-cd)
 - [Log Viewer](/docs/features/log-viewer)
 
+## Functionalities
+
+- [Multi Auth](/docs/functionalities/authentication)
+
 ## Support
 
 <p>You can show your support by starring this project.</p>

website/docs/3-api-documentation/_category_.json

@@ -1,7 +1,7 @@
 {
   "label": "API Documentation",
   "collapsible": true,
-  "collapsed": false,
+  "collapsed": true,
   "link": {
     "type": "generated-index",
     "title": "API Documentation",

website/docs/4-features/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Features",
   "collapsible": true,
-  "collapsed": false
+  "collapsed": true
 }

website/docs/5- functionalities/1-authentication.md

@@ -0,0 +1,27 @@
+---
+title: Authentication
+---
+
+Pandora comes with industry-grade authentication system including both user and admin authentication.
+
+## User Authentication
+
+The route definitions can be found [**here**](/docs/api-documentation/redoc#tag/auth).
+
+**Demo User Credentials**
+
+```
+Email: [email protected]
+Password: 123456
+```
+
+## Admin Authentication
+
+The route definitions can be found [**here**](/docs/api-documentation/redoc#tag/adminAuth).
+
+**Demo Admin Credentials**
+
+```
+Email: [email protected]
+Password: 123456
+```

website/docs/5- functionalities/_category_.json

@@ -0,0 +1,5 @@
+{
+  "label": "Functionalities",
+  "collapsible": true,
+  "collapsed": true
+}