Laravel Custom Base Project

Alvinditya Saputra included in Documentation

2020-03-06 593 words 3 minutes

Contents

Features

Basic Authentication
Json Web Token
Custom Error Handling
CORS Filter
Authority Access
Custom Middleware
Soft Deletes Service
Custom Form Validation
Auto Refresh Token Every 1 Hour (Ajax)
User Management

Documentation

Clone this project https://github.com/piinalpin/laravel-base.git.
Change.env.docker file to change database configuration to your database configuration and add basic auth configuration. Then copy .env.docker to .env

1
2
3
4
5
6
7
8
9
AUTH_USERNAME=<BASIC_AUTH_USERNAME>
AUTH_PASSWORD=<BASIC_AUTH_PASSWORD>

DB_CONNECTION=mysql
DB_HOST=<DATABASE_HOST>
DB_PORT=<DATABASE_PORT>
DB_DATABASE=<DATABASE_NAME>
DB_USERNAME=<DATABASE_USERNAME>
DB_PASSWORD=<DATABASE_PASSWORD>

Run php artisan migrate to migrate table on database.
Change database/AppUserSeeder.php according what do you want (optional), for this case I have two default user.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
DB::table('APP_USER')->insert([ 
	'created_at' => DB::raw('CURRENT_TIMESTAMP'),
	'created_by' => 0,
	'username' => 'admin',
    'full_name' => 'Administrator',
    'email' => '[email protected]',
    'password' => Hash::make('password'),
    'enabled' => true,
    'role' => 'ADMINISTRATOR'
]);

Run php artisan db:seed to seed data in database.
Run php artisan serve to run this project.

Run Using Docker

Install Docker desktop from Docker Hub
Install MySQL Docker if you want to use MySQL as container

1
docker run -p 3306:3306 --name mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:latest

Create database and add user for laravel docker, default IP Address for docker is 172.17.0.1

1
2
3
4
5
6
shell> docker exec -it mysql mysql -u root -p

mysql> CREATE DATABASE database_name;
mysql> CREATE USER 'newuser'@'172.17.0.1' IDENTIFIED BY 'user_password';
mysql> GRANT ALL PRIVILEGES ON database_name.* TO 'newuser'@'172.17.0.1';
mysql> FLUSH PRIVILEGES;

Change .env.docker to change database connection for mysql docker

1
2
3
4
5
6
DB_CONNECTION=mysql
DB_HOST=172.17.0.1
DB_PORT=3306
DB_DATABASE=database_name
DB_USERNAME=new_user
DB_PASSWORD=user_password

Run migration and seed data php artisan migrate && php artisan db:seed
Build web server on docker, you can see Dockerfile for web server at web.dockerfile

1
docker build -t laravel_web:latest -f web.dockerfile .

Build laravel application on docker, you can see Dockerfile for laravel application at app.dockerfile

1
docker build -t laravel_app:latest -f app.dockerfile .

Create network on docker and create connection for mysql docker on your network.

1
2
docker network create my-network
docker network connect my-network mysql

Adjust docker-compose.yml to run web server, application and connect to external mysql container.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
version: '3'

services:
  web:
    image: laravel_web:latest
    volumes:
      - ./:/var/www
    restart: always
    ports:
      - "8080:80"
      - "443:443"
    links:
      - app
    networks:
      - my-network

  app:
    image: laravel_app:latest
    env_file: '.env.docker'
    environment:
      - "DB_HOST=172.17.0.1"
      - "APP_URL=http://localhost:8080/api/v1"
    volumes:
      - ./:/var/www
    restart: always
    networks:
      - my-network

networks:
  my-network:
    external: true

Run docker-compose up -d to deploy docker image to container and docker-compose down to stop it.
Application should be can access at localhost:8080

API Documentation

Login /api/v1/oauth/token POST
- Header Authorization: Basic username and password as same as value of basic auth on .env
- Form Data username: admin and password: password
User Currently Logged In /api/vi/user/me GET
- Header Authorization: Bearer Token
Get All User /api/vi/user GET
- Header Authorization: Bearer Token

Create New User /api/vi/user/me POST

Header Authorization: Bearer Token
Request: application/json

1
2
3
4
5
6
7
8
9
{
	"username": "someuser",
	"email": "[email protected]",
	"fullName": "Some Name",
	"password": "somepassword",
	"confirmPassword": "somepassword",
	"enabled": true,
	"role": "SOME_ROLE"
}

Get Single User /api/vi/user/{id} GET
- Header Authorization: Bearer Token

Update User /api/vi/user/{id} POST

Header Authorization: Bearer Token
Request: application/json

1
2
3
4
5
6
7
8
9
{
	"username": "someuser",
	"email": "[email protected]",
	"fullName": "Some Name",
	"password": "somepassword",
	"confirmPassword": "somepassword",
	"enabled": true,
	"role": "SOME_ROLE"
}

Delete User /api/vi/user/{id} DELETE
- Header Authorization: Bearer Token

License

The Laravel framework is open-sourced software licensed under the MIT license.