https://github.com/kennethtomagan/laravel-6-api-boilerplate

A Laravel 6 API Boilerplate to create a ready-to-use REST API. User Authentication using JWT
https://github.com/kennethtomagan/laravel-6-api-boilerplate

api boilerplate jwt laravel laravel-api-boilerplate laravel6

Last synced: about 1 month ago
JSON representation

A Laravel 6 API Boilerplate to create a ready-to-use REST API. User Authentication using JWT

• Host: GitHub
• URL: https://github.com/kennethtomagan/laravel-6-api-boilerplate
• Owner: kennethtomagan
• Created: 2019-09-05T02:43:16.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-11T21:38:16.000Z (over 4 years ago)
• Last Synced: 2024-09-28T19:23:22.152Z (about 1 month ago)
• Topics: api, boilerplate, jwt, laravel, laravel-api-boilerplate, laravel6
• Language: PHP
• Homepage:
• Size: 514 KB
• Stars: 51
• Watchers: 4
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# laravel-api-boilerplate

[![Packagist](https://img.shields.io/packagist/v/kennethtomagan/laravel-6-api-boilerplate.svg)](https://packagist.org/packages/kennethtomagan/laravel-6-api-boilerplate)

[![Packagist](https://poser.pugx.org/kennethtomagan/laravel-6-api-boilerplate/d/total.svg)](https://packagist.org/packages/kennethtomagan/laravel-6-api-boilerplate)

[![Packagist](https://img.shields.io/packagist/l/kennethtomagan/laravel-6-api-boilerplate.svg)](https://packagist.org/packages/kennethtomagan/laravel-6-api-boilerplate)

This is a boilerplate for writing RESTful API projects using Laravel, a "Starter Kit" you can use to build your API in seconds.

##### Packages:

* JWT-Auth - [tymondesigns/jwt-auth](https://github.com/tymondesigns/jwt-auth)

* Laravel-CORS [barryvdh/laravel-cors](http://github.com/barryvdh/laravel-cors)

##### Require:

* PHP: ^7.2

## Features

* JWT Authentication

* Basic Features: Registration, Login, Update Profile & Password

* JSON API Format response.

* Unit/Feature Testing.

* Frontend Vue.js starter kit ready example ( https://github.com/kennethtomagan/Vue-CLI-Boilerplate ).

## Installation

`composer create-project kennethtomagan/laravel-6-api-boilerplate myNewProject`;

#### Install Dependencies

```

$ composer install

```

#### Configure the Environment

Create `.env` file:

```

$ cat .env.example > .env

```

Run `php artisan key:generate` and `php artisan jwt:secret`

#### Migrate and Seed the Database

```

$ php artisan migrate:fresh --seed

```

## Route API Endpoint

* Postman API Documentation Starter Kit https://documenter.getpostman.com/view/880526/SVtN3BkG?version=latest

| Verb     |                     URI                          |       Controller          |      Notes                                |

| -------- | -----------------------------------------------  | -----------------------   | ------------------------------------------

| POST     | `http://localhost:8000/api/auth/login`              |  AuthController           | to do the login and get your access token

| POST     | `http://localhost:8000/api/auth/register`          |  RegisterController       | to create a new user into your application

| POST     | `http://localhost:8000/api/auth/recovery`          |  ForgotPasswordController | to recover your credentials;

| POST     | `http://localhost:8000/api/auth/reset`             |  ResetPasswordController  | to reset your password after the recovery (setup your mail credentials in `.env` file to avoid error);

| POST     | `http://localhost:8000/api/auth/logout`            |  LogoutController         | to log out the user by invalidating the passed token;

| GET      | `http://localhost:8000/api/profile`           |  ProfileController        | to get current user data

| PUT      | `http://localhost:8000/api/profile`           |  ProfileController        | to update current user data

| PUT      | `http://localhost:8000/api/profile/password`  |  ProfileController        | to update current user password