Light

rajkum2 / laravel-6-api-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kennethtomagan/laravel-6-api-boilerplate

0.0 0.0 0.0 526 KB

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

PHP 97.34% HTML 2.66%

laravel-6-api-boilerplate's Introduction

laravel-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
Laravel-CORS 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

laravel-6-api-boilerplate's People

Contributors

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.