Download the PHP package rygilles/laravel-api-boilerplate without Composer

On this page you can find all versions of the php package rygilles/laravel-api-boilerplate. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of rygilles/laravel-api-boilerplate

Informations about the package laravel-api-boilerplate

Laravel API Boilerplate

StyleCI Build Status

This is a Laravel Laravel 5.* based project.

Prerequisites

Setup

Run this command and make sure to chmod properly the storage and cache folders.

Or install this project manually by cloning with git. In this case, you must copy the .env.example file to .env and run this command :

.env file

Check the .env file and change the values according to you preferences.

Libs

This project uses the same libraries as Laravel common projects.

But also (Check package.json file for details) :

Production environment

PHP, with composer

Back-office, Node.js dependencies

Development environment

Back-office, Node.js dependencies

Vue.js :

Graphics :

Laravel :

Miscellaneous :

Database

This application use InnoDB tables for foreign keys constraint support and utf8mb4_unicode_ci encoding for modern chars support (including emoji). It also use UUID (128 bits).

Initialize

Run this command to create the database basics with default migrations (check database/migrations directory).

Make sure Redis is installed properly.

This will install :

Laravel basic tables : user, password_resets, notification, jobs

Passport bundle tables : oauth_auth_codes, oauth_access_tokens, oauth_refresh_tokens, oauth_clients_table, oauth_personal_access_clients)

Boilerplate tables : i18n_lang, user_group

Samples Data

An Artisan command (See below) can supply your database with samples data for users, projects, etc, for testing and documentation generation purpose.

Check database/seeds/Samples folder for more information.

User ID User Group ID Name Email Password
41abdec2-1389-11e7-93ae-92361f002671 Developer John Doe [email protected] johndoe
509dd5c0-1389-11e7-93ae-92361f002671 Support Alan Smithee [email protected] alansmithee
605c7610-1389-11e7-93ae-92361f002671 End-User John Smith [email protected] johnsmith
82b5da82-138c-11e7-93ae-92361f002671 End-User Mickey Mouse [email protected] mickeymouse

Node, Laravel Mix and Laravel Echo Server

NodeJs

Install NodeJs dependencies (check package.json file for more information).

Laravel Mix

Assets

Create your own back-office images by replacing :

Check the webpack.mix.js to enable favicon.jpg copy and manage you own assets.

Compilation

Run this command to compile the assets

Laravel Echo Server

Real-time notifications and events are send by a local Node.js server, using Redis and Socket.io.

The whole process is handled by laravel-echo-server.

Initialize Laravel Echo Server by creating laravel-echo-server.json configuration file with this command :

Start and Auto-restart

Use PM2 for auto-restart feature

Make sure you've configured all in laravel-echo-server.ecosystem.config.json file. :

Or use this command to manually start the server :

Artisan commands

app:makeFresh

This command will reset/refresh migrations, re-create required database data and (optionally) create a fresh app with samples data.

app:generateApiDocs

Generate API documentation using current database resources.

Make sure you've configured all in config/apidocs.php file.

app:makeApiModelResource

Only in development environment !

Generate and MODIFY source files to add a new model with related files :

During this command execution, the Laravel application will be down (php artisan down then php artisan up at the end, called implicitly).

Composer dump autoloads will be called at the end.

app:makeApiModelResourceAssets

Only in development environment !

Generate and MODIFY basic assets source files for a new resource model in the dashboard :

During this command execution, the Laravel application will be down (php artisan down then php artisan up at the end, called implicitly).

Make sure to run npm run dev or npm run watch to check your assets compilation.

(Upcoming upgrades to do : Model resource analysis to complete new components fields and other stuff like this.)

openApiSchemas:generate

This command is provided by the rygilles/laravel-openapi-schema-generator package.

It will analyze your laravel project files and generate a openapi json file, describing the capabilities of your Api.

Check the config/openapischemas.php configuration file before running this command.

Some information can not be retrieve automatically by the script, you might update/add data in the "openapi_bindings" configuration array.

ide-helper:generate

This command is provided by barryvdh/laravel-ide-helper package.

Only for development environment

This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date. If you don't want to generate it, you can add a pre-generated file to the root folder of your Laravel project (but this isn't as up-to-date as self generated files).

All versions of laravel-api-boilerplate with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1
alsofronie/eloquent-uuid Version ^1.0
barryvdh/laravel-debugbar Version ^3.1
bugsnag/bugsnag-laravel Version ^2.0
dingo/api Version 2.0.0-alpha2
doctrine/dbal Version ^2.5
felixkiss/uniquewith-validator Version ^3.0
fideloper/proxy Version ~4.0
filp/whoops Version ^2.1
guzzlehttp/guzzle Version ^6.2
laravel/framework Version 5.6.*
laravel/passport Version ^6.0
laravel/tinker Version ~1.0
predis/predis Version ^1.1
rygilles/laravel-apidoc-generator Version 0.1.1
rygilles/laravel-openapi-schema-generator Version v0.3.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rygilles/laravel-api-boilerplate contains the following files

Loading the files please wait ....