- Update composer details and readme for the project configuration

Author: vicky-ftxinfotech

composer.json

@@ -1,15 +1,15 @@
 {
-    "name": "ftx/laravel-starter",
+    "name": "ftx/laravel-adminpanel",
     "type": "project",
-    "description": "The Laravel Starter Project.",
+    "description": "The Laravel AdminPanel with API Boilerplate.",
     "keywords": [
         "framework",
         "laravel",
         "boilerplate"
     ],
     "license": "MIT",
     "require": {
-        "php": "^7.2",
+        "php": "^7.3",
         "albertcht/invisible-recaptcha": "^1.9",
         "altek/accountant": "^1.2",
         "altek/eventually": "^1.0",

readme.md

@@ -9,12 +9,13 @@
 ![GitHub stars](https://img.shields.io/github/stars/rappasoft/laravel-boilerplate.svg?style=social)
 
 ### Introduction
-
+---
 Laravel Starter provides you with a massive head start on any size web application. It comes with a full featured access control system out of the box with an easy to learn API and is built on a Bootstrap foundation with a front and backend architecture. We have put a lot of work into it and we hope it serves you well and saves you time!
 
-MIT: [http://anthony.mit-license.org](http://anthony.mit-license.org)
+*MIT: [http://anthony.mit-license.org](http://anthony.mit-license.org)*
 
 ### Setup
+---
 Clone the repo and follow below steps.
 1. Run `composer install`
 2. Copy `.env.example` to `.env` Example for linux users : `cp .env.example .env`
@@ -28,11 +29,29 @@ Clone the repo and follow below steps.
 
 Thats it... Run the command `php artisan serve` and cheers, you are good to go with your new **Laravel Starter** application.
 
+
+### Using docker to run the application
+---
+1. `docker-compose build`
+2. `docker/cli composer install`
+3. `docker/cli php artisan key:generate`
+4. `docker/cli php artisan migrate`
+5. `docker/cli php artisan passport:install`
+6. `docker/cli php artisan db:seed`
+7. `docker/npm i`
+8. `docker/npm run dev`
+9. `docker-compose up -d`
+
+You can login to docker cli using the command `docker exec -ti ls-www /bin/bash`
+
+*Note: Please make sure that you have proper permissions when setting up the project via docker.*
+
+---
 The application uses [GrumPHP](https://github.com/phpro/grumphp) for the git pre-commit hook and [PHPCSFixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) for the code standards. You can also bypass the `GrumPHP` pre-commit hook by hitting `git commit -n` or `git commit --no-verify`
 
 ### Demo Credentials
-
-Make sure you have run the command `php artisan db:seed --class UserTableSeeder` before you use these credentials.
+---
+*Make sure you have run the command `php artisan db:seed --class UserTableSeeder` before you use these credentials.*
 
 **User:** admin@admin.com\
 **Password:** 1234
@@ -41,4 +60,12 @@ Make sure you have run the command `php artisan db:seed --class UserTableSeeder`
 **Password:** 1234
 
 **User:** user@user.com\
-**Password:** 1234
+**Password:** 1234
+
+### Useful Commands
+---
++ To format your code: `composer format`
++ To run the test cases: `./vendor/bin/phpunit`
+    + The test cases report will be placed in the `reports` directory
++ To generate scribe API documentation: `php artisan scribe:generate`
+    + Documentation will be generated and placed in the `public/docs` directory