https://github.com/gent-fella-health/laravel-api-starter
⭐️ Build APIs You Won't Hate In Laravel.
https://github.com/gent-fella-health/laravel-api-starter
clean-laravel-api larapi laravel laravel-api laravel-api-boilerplate laravel-boilerplate laravel-passport passport
Last synced: 5 months ago
JSON representation
⭐️ Build APIs You Won't Hate In Laravel.
- Host: GitHub
- URL: https://github.com/gent-fella-health/laravel-api-starter
- Owner: gent-fella-health
- Created: 2020-07-25T19:27:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-01T20:23:17.000Z (almost 2 years ago)
- Last Synced: 2025-05-08T07:55:19.031Z (5 months ago)
- Topics: clean-laravel-api, larapi, laravel, laravel-api, laravel-api-boilerplate, laravel-boilerplate, laravel-passport, passport
- Language: PHP
- Homepage:
- Size: 286 KB
- Stars: 98
- Watchers: 7
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Introduction
**Laravel API Starter** streamlines modern API development in Laravel. This carefully crafted starter project is designed to simplify and expedite your journey in building APIs with Laravel. Serving as a launchpad for your next project, it equips you with a comprehensive set of ready-to-use tools commonly required in API development. Save time and kickstart your Laravel API project effortlessly with **Laravel API Starter**.
**Laravel API Starter** comes included with...
* Laravel Passport for OAuth Authentication, including a proxy for password and refresh-token grants.
* A new directory structure optimized for separating infrastructure and domain code. Groups your controllers, models, etc. by resource-type.
* A modern exception handler for APIs.
* A base controller class that gives sorting, filtering, eager loading and pagination for your endpoints.
* A base repository class for requesting entities from your database.
* A library for creating advanced structures of related entities.
## Automatic Installation
```bash
git clone https://github.com/gentritabazi/laravel-api-starter && cd laravel-api-starter && sh ./scripts/install.sh
```
This will:
- Create the project.
- Install the dependencies.
- Create the `.env` file in the project root.
- Generate the `APP_KEY`.
- Create a symbolic link from `public/storage` to `storage/app/public`.
Now you just need to update your `.env` file as needed and install passport (check below how to install passport).
### Manual Installation
First clone the repository.
```bash
git clone https://github.com/gentritabazi/laravel-api-starter
```
Install dependencies.
```bash
composer install
```
Copy the `.env` file an create and application key.
```bash
cp .env.example .env && php artisan key:generate
```
Create a symbolic link from `public/storage` to `storage/app/public`.
```bash
php artisan storage:link
```
Migrate the tables.
```bash
php artisan migrate
```
Project comes with Passport include as the default authenticatin method. You should now install it using this command.
```bash
php artisan passport:install
```
Copy-paste the generated secrets and IDs into your `.env` file like so.
```bash
PERSONAL_CLIENT_ID=1
PERSONAL_CLIENT_SECRET=SECRET_HERE
PASSWORD_CLIENT_ID=2
PASSWORD_CLIENT_SECRET=SECRET_HERE
```
If you want to save it elsewhere or change the naming be sure to modify the LoginService in `infrastructure/Auth/Services/LoginService.php`
If you want to use docker to install composer dependencies use this [script](https://laravel.com/docs/8.x/sail#installing-composer-dependencies-for-existing-projects).
## Test installation
You can quickly test if the authentication works by creating an user using the include command.
```bash
php artisan users:add {first_name} {last_name} {email} {password}
Example: php artisan users:add Gentrit Abazi gentritabazi@gmail.com mypassword
```
Now serve your application and try to request a token using cURL
```bash
php artisan serve
curl -X POST http://localhost:8000/login -H 'Content-Type:application/json' -d '
{
"email": "gentritabazi@gmail.com",
"password": "mypassword"
}'
```
This should return a token.
```json
{
"access_token": "TOKEN_HERE",
"expires_in": 600
}
```
Now try to request all users `GET /users` using the newly issued token.
```bash
curl http://localhost:8000/users -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImM0MWZiOWFjZjkyZmRiY2RhYjE0ZmEwYTFlMzMwYjBjYTEwMmRiMTA1ZGI4MmZjYzllZGUwMjRiNzI2MjA2YjRhZDU4MGZhMjUxODU2Y2RkIn0.eyJhdWQiOiIyIiwianRpIjoiYzQxZmI5YWNmOTJmZGJjZGFiMTRmYTBhMWUzMzBiMGNhMTAyZGIxMDVkYjgyZmNjOWVkZTAyNGI3MjYyMDZiNGFkNTgwZmEyNTE4NTZjZGQiLCJpYXQiOjE0ODk5NTM3MDYsIm5iZiI6MTQ4OTk1MzcwNiwiZXhwIjoxNDg5OTU0MzA2LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.SmsEyCEXBiwSgl0yMcjvCxoZ2a_7D6GDJTxTs_J-6yzUeJkOofrSV7RRafO3VvUckrNqy5sGgglrwGH_HN7_lNPU6XcgaaNzbzf-g7vCSzCicJiYZVzxqJpZVwqQ4WIQrc0lYdk7suZ7hwQulOD_Z79JhBNh1KSAyo3ABWHiRjh9NR_-iAjvlCohh7nAETDeVqoMrR99m3fwQYOjdtvRBHJ8Ei-Kx3Gn1DyOXyh8eGa5-yDtj-ZVI9x66YMXlm8wk4IMA_Oh7KJISfdpoQs4fPyrGsFAxQMFp02qEW2fzKl2eesZeiIAyDGWE4StHsuY3E4jZL0P-pjv08j5W4CBP0P64gkNw_GdbxlPPA-qZUzJlc3EtjrzZ9WZq3JAKKCGy5I1jHECDOqaQ1z7axm6rmxRWmXmRGwwkne8QxfPlXsN0sm5q98mJckeqCLUuir1VPyFn5Z-B7D80-sc7Zm-7zi-awJtZUGMcHSo_yNHXjVGcbJwFk04xoIL2QzMXpOVPLaUdlBp_obCJhdzT5Bx0o5SDdK2LwgEwbMkksqmrTJ7ypoezsc3ihVQIrMelK2lNfkH_cDcVdD3ub8oFTthbA62U6atXaIADcsgTCgOtgQ2uXTIko_btjECgL35LZDd8UxiyQT3w-pDrELGDPx17DQCsIZDJ8mC1s6E0d7EPsA'
```
This should return a response like so
```json
{
"users": [
{
"id":1,
"first_name": "Gentrit",
"last_name": "Abazi",
"email": "gentritabazi@gmail.com",
"name": "Gentrit Abazi"
}
]
}
```
You can refresh a new token by requesting `POST /login/refresh` and logout using `POST /logout`.
## Directory structure example
- [Laravel 7.0](https://github.com/gentritabazi/laravel-api-starter/tree/Laravel-7)
- [Laravel 8.0](https://github.com/gentritabazi/laravel-api-starter/tree/Laravel-8).