Initial commit

Author: Mentorg

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.example

@@ -0,0 +1,58 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=laravel_restapi
+DB_USERNAME=root
+DB_PASSWORD=
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
+PUSHER_APP_CLUSTER=mt1
+
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore
+.styleci.yml export-ignore

.gitignore

@@ -0,0 +1,16 @@
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+auth.json
+npm-debug.log
+yarn-error.log
+/.idea
+/.vscode

README.md

@@ -0,0 +1,67 @@
+
+# Laravel REST API
+
+This is a basic CRUD API made with the latest version of Laravel (9.x), a popular framework made on top of PHP. The project makes use of Service Layer-Repository Pattern in order to keep the code clean and organized, custom authentication, and authorization with the help of Spatie's permission package.
+
+## Basic Usage
+
+Follow the steps below in order to start using this application.
+
+#### Create Database
+
+`$ php artisan db:create`
+
+#### Define database schema
+
+`$ php artisan migrate`
+
+#### Populate the database with data
+
+`$php artisan db:seed`
+
+#### Run the application
+
+`php artisan serve`
+
+#### Authentication credentials
+
+Email: `[email protected]`\
+Password: `password`
+
+## Test Endpoints
+
+Use the following endpoints in order to test the application.
+
+#### Authentication
+
+User Register: **POST** `localhost:8000/api/register`\
+User Login: **POST** `localhost:8000/api/login`\
+User Logout: **POST** `localhost:8000/api/login`
+
+#### Authorization
+
+List Roles: **GET** `localhost:8000/api/roles`\
+Get Role:  **GET** `localhost:8000/api/roles/3`\
+Add Role: **POST** `localhost:8000/api/roles`\
+Update Role: **PUT** `localhost:8000/api/roles/3`\
+Delete Role: **DELETE** `localhost:8000/api/roles/3`\
+Search Keyword: **GET** `localhost:8000/api/roles?search=lorem`
+
+#### Articles
+
+List Articles: **GET** `localhost:8000/api/articles`\
+Get Article:  **GET** `localhost:8000/api/articles/3`\
+Add Article: **POST** `localhost:8000/api/articles`\
+Update Article: **PUT** `localhost:8000/api/articles/3`\
+Delete Article: **DELETE** `localhost:8000/api/articles/3`\
+Search Keyword: **GET** `localhost:8000/api/articles?search=lorem`
+
+#### Users
+
+List Users: **GET** `localhost:8000/api/users`\
+Get User:  **GET** `localhost:8000/api/users/3`\
+Update User: **PUT** `localhost:8000/api/users/3`\
+Delete User: **DELETE** `localhost:8000/api/users/3`\
+Search Keyword: **GET** `localhost:8000/api/users?search=lorem`
+
+**Node:** If you're using Postman to test this API, don't forget to add HTTP Header key "Accept" with the value "application/json".

app/Console/Commands/dbcreate.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\DB;
+
+class dbcreate extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'db:create {name?}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new MySQL database based on the database config file or the provided name.';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        $schemaName = $this->argument('name') ?: config("database.connections.mysql.database");
+        $charset = config("database.connections.mysql.charset",'utf8mb4');
+        $collation = config("database.connections.mysql.collation",'utf8mb4_unicode_ci');
+
+        config(["database.connections.mysql.database" => null]);
+
+        $query = "CREATE DATABASE IF NOT EXISTS $schemaName CHARACTER SET $charset COLLATE $collation;";
+
+        DB::statement($query);
+
+        config(["database.connections.mysql.database" => $schemaName]);
+    }
+}

app/Console/Kernel.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Console;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+class Kernel extends ConsoleKernel
+{
+    /**
+     * Define the application's command schedule.
+     *
+     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
+     * @return void
+     */
+    protected function schedule(Schedule $schedule)
+    {
+        // $schedule->command('inspire')->hourly();
+    }
+
+    /**
+     * Register the commands for the application.
+     *
+     * @return void
+     */
+    protected function commands()
+    {
+        $this->load(__DIR__.'/Commands');
+
+        require base_path('routes/console.php');
+    }
+}

app/Exceptions/Handler.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Exceptions;
+
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Throwable;
+
+class Handler extends ExceptionHandler
+{
+    /**
+     * A list of exception types with their corresponding custom log levels.
+     *
+     * @var array<class-string<\Throwable>, \Psr\Log\LogLevel::*>
+     */
+    protected $levels = [
+        //
+    ];
+
+    /**
+     * A list of the exception types that are not reported.
+     *
+     * @var array<int, class-string<\Throwable>>
+     */
+    protected $dontReport = [
+        //
+    ];
+
+    /**
+     * A list of the inputs that are never flashed to the session on validation exceptions.
+     *
+     * @var array<int, string>
+     */
+    protected $dontFlash = [
+        'current_password',
+        'password',
+        'password_confirmation',
+    ];
+
+    /**
+     * Register the exception handling callbacks for the application.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->reportable(function (Throwable $e) {
+            //
+        });
+    }
+}

app/Filters/Search.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Filters;
+use Samushi\QueryFilter\Filter;
+
+class Search extends Filter
+{
+    private $search;
+
+    public function __construct(array $search = ['query'])
+    {
+        $this->search = $search;
+    }
+
+    /**
+     * Search Result by whereLike
+     * @param $builder
+     * @return mixed
+     */
+    protected function applyFilter($builder)
+    {
+        return $builder->whereLike($this->search, request()->get($this->fillterName()));
+    }
+}