rekamy/generator

Web & API Generator with Swagger API Doc

v6.2.1 2023-02-12 08:45 UTC

Requires

• php: ^7.2 || ^8.0
• doctrine/dbal: ^2.9 || ^3.0.0
• laravel/framework: ^8.0 || ^7.0 || ^9.0

Suggests

• darkaonline/l5-swagger: Needed to provide swagger api documentation
• laravel/passport: Needed for authentication and authorization
• prettus/l5-repository: Needed for using repository patterns
• spatie/laravel-permission: Needed for granular authorization control

MIT

• Firdaus Ishaddin
• Zahrin Azam
• Shahrin Nidzam
• Razlan Razak

• generator
• api
• repository
• view
• controller
• model
• request
• crud
• laravel
• swagger
• DesignPattern

README

Introduction

This Generator will generate a complete SPA (Vue JS) CRUD along with the Swagger API Documentation.

Table Of Contents

Click to expand

• Introduction
• Installation
• Configuration
• Usage
• License

Installation

The recommended way to install Rekamy Generator is through Composer.

composer require rekamy/generator

Next, you will need to publish the generator's config file by running :

php artisan vendor:publish --provider "Rekamy\Generator\GeneratorServiceProvider"

Configuration

Update the configuration file based on your needs.

// Setup your application name here(For Swagger Use).
'app_name' => env('APP_NAME'),

// Which file would you like to generate. Set the value to false you don't want to generate.
'generate' => [
    // ...
],

// Database configuration. Set your database name here or from .env and exclude any tables you don't want to generate
'database' => [
    // Database name
    'name'           => env('DB_DATABASE'),

    // Exclude table name
    'exclude_tables' => [
        // ...
    ]
],

// Path is where you want the generator to generate.
'path' => [
    // ...
],

// Namespace for the generated files.
'namespace' => [
    // ...
],

// options is an add on you can disable these options by setting the value to false
'options' => [
    // ...
]

Usage

(Optional) Publish configuration :

php artisan vendor:publish --tag="rekamygenerator"

In order to run the generator after configuration, you can run it via :

php artisan generate

Todo

• handle table name ending with 's'
• progress bar as per Razlan done in previous version

License

Rekamy Generator is open-sourced software licensed under the MIT license