added comprehensive readme

Author: root

.env.docker

@@ -6,15 +6,18 @@ APP_LOG_LEVEL=debug
 APP_URL=http://laravel.dev
 APP_DOMAIN=laravel.dev
 
-API_DOMAIN=api.laravel.dev
-API_DEBUG=true
-API_STANDARDS_TREE=vnd
-API_SUBTYPE=apisubtype
+JWT_SECRET=d4ss58MG60wUGVeSRDg8vTRovXyFX0YO
+API_STANDARDS_TREE=x
+API_SUBTYPE=starterpack
+API_DOMAIN=api.fb.dev
 API_VERSION=v1
-API_NAME="Laravel Dev Api"
+API_NAME="Fb Api"
+API_STRICT=false
+API_DEFAULT_FORMAT=json
+API_DEBUG=true
+
 SIGN_UP_RELEASE_TOKEN=true
 PASSWORD_RESET_RELEASE_TOKEN=true
-JWT_SECRET=aYLINRYJugcmNYoZ8xDVJUh2EcibPduu
 
 DB_CONNECTION=mysql
 DB_HOST=mysql
@@ -42,3 +45,8 @@ MAIL_PORT=2525
 MAIL_USERNAME=ccbcdcb6f224ce
 MAIL_PASSWORD=7ad210d0196bb5
 
+FB_APP_ID=1291841020933336
+FB_APP_SECRET=ab2676e1ec89bae6a6dfa21bca286f29
+FB_GRAPH_VERSION=v2.9
+FB_REDIRECT_URL=http://api.fb.dev/fb/callback
+

.env.example

@@ -0,0 +1,43 @@
+APP_ENV=local
+APP_KEY=base64:S3UF3QcIp+3nzPKsfkQ9Zr5/rOVvLUsxOA8JuN7zs50=
+APP_DEBUG=true
+APP_LOG_LEVEL=debug
+APP_URL=http://localhost
+APP_DOMAIN=fb.dev
+APP_NAME="Laravel Api"
+
+DB_CONNECTION=sqlite
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+SESSION_DRIVER=file
+QUEUE_DRIVER=sync
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_DRIVER=smtp
+MAIL_HOST=mailtrap.io
+MAIL_PORT=2525
+MAIL_USERNAME=AddYourUsernameHere
+MAIL_PASSWORD=AddYourPasswordHere
+MAIL_ENCRYPTION=null
+
+FB_APP_ID=AddYourAppIDHere
+FB_APP_SECRET=AddYourSecretHere
+FB_GRAPH_VERSION=v2.9
+FB_REDIRECT_URL=http://api.fb.dev/fb/callback
+
+SIGN_UP_RELEASE_TOKEN=true
+PASSWORD_RESET_RELEASE_TOKEN=true
+
+JWT_SECRET=d4ss58MG60wUGVeSRDg8vTRovXyFX0YO
+API_STANDARDS_TREE=x
+API_SUBTYPE=starterpack
+API_DOMAIN=api.fb.dev
+API_VERSION=v1
+API_NAME="Fb Api"
+API_STRICT=false
+API_DEFAULT_FORMAT=json
+API_DEBUG=true

.env.simple

@@ -1,6 +1,6 @@
-### Using Dingo Api
+# 1. Using Dingo Api
 
-#### using api.domain.com
+## 1.1. using api.domain.com
 if you are using this. you need to uncomment at VerifyCsrfToken.php
 
 Meaning you set you API_DOMAIN=api.domain.dev at your .env
@@ -10,7 +10,7 @@ protected $except = [
     ];
 ```
 
-#### using prefix /api
+## 1.2. using prefix /api
 if you are using this you need this at VerifyCsrfToken.php
 
 ```
@@ -19,51 +19,81 @@ protected $except = [
     ];
 ```
 
-#### Using Transformers
+## 1.3. Set Your ENV Variable OR Configure Your Config/api.php
 
-#### Configuring Config/api.php
+Set Your ENV Variable
+[./config/api.php](../config/api.php)
+[.env](../.env.docker)
 
+Note: You Cant Access Api End Point In your Browser , Only Via AJAX Request of Postman IF
 
-#### Using Postman
-- Open [Postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en)
+```
+API_STRICT =  true
+```
+
+# 2. Testing Endpoint Using Postman
+
+### 2.0.1. Download [Postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en)
+
+
+## 2.1. Create an Account and Login with your Postman Credentials
+
+## 2.2. Add to Neccessary header 
 
-- add to header ,where API_SUBTYPE is define in our .env (Use for Accessing Specific Api Version)
+- where API_SUBTYPE is define in our .env (Use for Accessing Specific Api Version)
 
 ```
 Accept: application/vnd.YOUR_SUBTYPE.v1+json
 ```
 
 
-- Make Post Request to login
+## 2.3. Make Post Request to login
 
+### 2.3.1. URL to Hit
 ```
 http://api.laravel.dev/auth/login
 or
 http://laravel.dev/auth/login
 ```
 
-- Add to Body
+### 2.3.2. Add to Body
 ```
 email = admin@laravel.dev
 password = password
 ```
+## 2.4. We Get the Access Token (JWT)
+
 
-- You will see Response something like this
 ```
 {
   "status": "ok",
   "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6XC9cL2FwaS5sYXJhdmVsLmRldlwvYXV0aFwvbG9naW4iLCJpYXQiOjE0ODkzMzI1OTcsImV4cCI6MTQ4OTM5NzM5NywibmJmIjoxNDg5MzMyNTk3LCJqdGkiOiJjODMxNTMzZjkzMGFiOTkzMGExMzhkMGNkOTI5NGI3ZCJ9.3v-cGtXA-ySmL67pp4kZ4U4Mf3v7ge_CzUEdWIRKSeM"
 }
 ```
-If .env
-```
-API_STRICT =  true
-```
-Header 
 
-Key:
-Accept
+# 3. Returning a response with cookie
 
-Value:
-application/x.apisubtype.v1+json
+Note: our ENV 
 
+SESSION_DOMAIN=.laravel.dev
+
+You can Do this Inside Your Controller 
+```
+
+$name = 'samplecookie';
+$value = 'my-cookie';
+$minutes = 60;
+$path = '/';
+$domain = 'api.laravel.dev';
+$secure = false;
+$httpOnly =false;
+return response()
+->json([
+    'status' => 'ok',
+    'token' => $token,
+    'firstName' => $firstname,
+    'lastName' => $lastname,
+    'email' => $email
+])->header('Authorization','Bearer ' . $token)
+->withCookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly);
+```

Docs/API.md

@@ -0,0 +1,102 @@
+#### Compiling Assets
+
+npm run dev - this will compile your app for dev
+
+npm run hot - enable hot reloading
+
+npm run production - compile for production all minification are added here
+
+npm run watch - if you enable browsersync this is command to run
+
+npm run watch poll - if you the app is a bit sluggish you may need to run this instead of watch.
+
+
+#### Custom Styling
+
+Edit: resources/assets/sass/app.scss
+
+And Add All Your Custom CSS Here
+
+Also Remember to uncomment this on your webpack.mix.js
+
+after your first npm run dev
+
+```
+  //  .sass('resources/assets/sass/app.scss', 'public/css')
+```
+
+This File is Empty by Default.
+
+
+#### Changing Fonts
+
+
+You May reference or Use Font Awesome...
+
+by defining it in your Buefy Constructor
+
+
+Path: resources\assets\js\app.js
+```
+Vue.use(Buefy, {
+    defaultIconPack: 'fa',
+    defaultContentElement: '#content',
+    ...
+})
+
+```
+
+Note: that The Default  Icon is Material Icon
+and is reference in our 
+
+resources/views/app.blade.php 
+```
+ <link rel="stylesheet" href="//fonts.googleapis.com/icon?family=Material+Icons">
+```
+
+#### Edit Main Layout template
+
+
+resources\assets\js\views\Layouts\main.vue
+
+Default :
+
+You Check all [Variables Here](http://bulma.io/documentation/overview/variables/)
+
+```
+<style lang="scss">
+// Import Bulma's core
+@import "~bulma/sass/utilities/_all";
+
+// Set your colors
+$primary: #8c67ef;
+$primary-invert: findColorInvert($primary);
+$twitter: #4099FF;
+$twitter-invert: findColorInvert($twitter);
+
+// Setup $colors to use as bulma classes (e.g. 'is-twitter')
+$colors: (
+    "white": ($white, $black),
+    "black": ($black, $white),
+    "light": ($light, $light-invert),
+    "dark": ($dark, $dark-invert),
+    "primary": ($primary, $primary-invert),
+    "info": ($info, $info-invert),
+    "success": ($success, $success-invert),
+    "warning": ($warning, $warning-invert),
+    "danger": ($danger, $danger-invert),
+    "twitter": ($twitter, $twitter-invert)
+);
+
+// Links
+$link: $primary;
+$link-invert: $primary-invert;
+$link-focus-border: $primary;
+
+// Import Bulma and Buefy styles
+@import "~bulma";
+@import "~buefy/src/scss/buefy";
+</style>
+```
+
+#### For more Info About Buefy Go to this [LINK](https://buefy.github.io/?#/documentation/quick-start)