This repo is functionality complete — PRs and issues welcome!
Please check the official laravel installation guide for server requirements before you start. Official documentation
Clone the repository
git clone git@github.com:otim22/loan-management.git
Switch to the repo folder
cd loan-management
Install all the dependencies using composer
composer install
Copy the example env file and make the required configuration changes in the .env file
cp .env.example .env
Generate a new application key
php artisan key:generate
Generate a new JWT authentication secret key
php artisan jwt:generate
Run the database migrations (Set the database connection in .env before migrating)
php artisan migrate
Start the local development server
php artisan serve
You can now access the server at http://localhost:8000
TL;DR command list
git clone git@github.com:otim22/loan-management.git
cd loan-management
composer install
cp .env.example .env
php artisan key:generate
php artisan jwt:generate
Make sure you set the correct database connection information before running the migrations Environment variables
php artisan migrate
php artisan serve
Populate the database with seed data with relationships which includes users, articles, comments, tags, favorites and follows. This can help you to quickly start testing the api or couple a frontend and start using it with ready content.
Open the DummyDataSeeder and set the property values as per your requirement
database/seeds/UsersTableSeeder.php
Run the database seeder and you're done
php artisan db:seed --class=UsersTableSeeder
Note : It's recommended to have a clean database before seeding. You can refresh your migrations at any point to clean the database by running the following command
php artisan migrate:refresh
The api can be accessed at http://localhost:8000/api.
- jwt-auth - For authentication using JSON Web Tokens
- lumen-generator - To add any Laravel code generator on your Lumen project
- redis - To handle any application caching
- inspector-laravel - To connect your Lumen application to Inspector.
app/Models- Contains all the Eloquent modelsapp/Http/Controllers- Contains all the api controllersapp/Http/Middleware- Contains the JWT auth middlewareconfig- Contains all the application configuration filesdatabase/factories- Contains the model factory for all the modelsdatabase/migrations- Contains all the database migrationsdatabase/seeds- Contains the database seederroutes- Contains all the api routes defined in api.php filestorage- Contains all the api storage, logging detailstests- Contains all the application tests
.env- Environment variables can be set in this file
Note : You can quickly set the database information and other variables in this file and have the application fully working.
Run the laravel development server
php artisan serve
The api can now be accessed at
http://localhost:8000
Request headers
| Required | Key | Value |
|---|---|---|
| Yes | Content-Type | application/json |
| Yes | X-Requested-With | XMLHttpRequest |
| Yes | Authorization | Token {JWT} |
Find an invite to Postman below and test the endpoints
https://app.getpostman.com/join-team?invite_code=9f59467bbf22d370bf0b010a4b66fdb3&target_code=bcacafe6133e03ca7339a31e70d18a92
This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the Authorization header with Token scheme. The JWT authentication middleware handles the validation and authentication of the token. Please check the following sources to learn more about JWT.
Make you install deployer on your local machine. By running the following composer require --dev deployer/deployer
To initialize deployer in your project run: vendor/bin/dep init
Add next alias to your .bashrc file: alias dep='vendor/bin/dep'
Now lets cd into the project and run the following command: dep init
Check a sample of deploy script in the root project called "deploy.sample.php"
To deploy the project: dep deploy
Ssh to the host, for example, for editing .env file: dep ssh
TL;DR command list
composer require --dev deployer/deployer
vendor/bin/dep init
alias dep='vendor/bin/dep'
dep init
dep deploy
Please find the deployer documentation below here
Yah! You are finally done.