updated base config

Author: dipaksarkar

.editorconfig

@@ -2,8 +2,17 @@ root = true
 
 [*]
 charset = utf-8
-indent_style = space
-indent_size = 2
 end_of_line = lf
 insert_final_newline = true
+indent_style = space
+indent_size = 4
 trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.example

@@ -1,48 +1,65 @@
-APP_NAME=Qaravel
+APP_NAME=APP_NAME=Qaravel
 APP_ENV=local
-APP_KEY=base64:2UkK1HvAMdBAHUfIZOQX8xTRc7v6Ik6I+FGcYKdlmpg=
+APP_KEY=base64:WxtI6bGfS2nBHzH5VCosFroXjrDpNnrbfEIeyMea0xI=
 APP_DEBUG=true
 APP_URL=http://qaravel.gomedia
-SANCTUM_STATEFUL_DOMAINS=qaravel.gomedia:8080
 
 LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
 
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
 DB_DATABASE=qaravel
 DB_USERNAME=root
-DB_PASSWORD=
+DB_PASSWORD=password
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=file
-QUEUE_CONNECTION=sync
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=database
+QUEUE_DRIVER=database
 SESSION_DRIVER=file
 SESSION_LIFETIME=120
 SESSION_DOMAIN=.qaravel.gomedia
 
+MEMCACHED_HOST=127.0.0.1
+
 REDIS_HOST=127.0.0.1
 REDIS_PASSWORD=null
 REDIS_PORT=6379
 
 MAIL_MAILER=smtp
-MAIL_HOST=smtp.mailtrap.io
-MAIL_PORT=2525
+MAIL_HOST=127.0.0.1
+MAIL_PORT=1025
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
-MAIL_FROM_ADDRESS=null
+MAIL_FROM_ADDRESS="[email protected]"
 MAIL_FROM_NAME="${APP_NAME}"
 
 AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
 AWS_DEFAULT_REGION=us-east-1
 AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
 
 PUSHER_APP_ID=
 PUSHER_APP_KEY=
 PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
 PUSHER_APP_CLUSTER=mt1
 
-MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
-MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+
+# Custom config
+APP_DOMAIN=qaravel.gomedia
+# TUNNEL_WEB_DOMAIN=9a7e-110-172-131-234.ngrok.io
+SANCTUM_STATEFUL_DOMAINS=*.qaravel.gomedia:9000,qaravel.gomedia:9000,*.qaravel.gomedia,qaravel.gomedia

.env.frontend

@@ -2,6 +2,8 @@
 # The data added here will be propagated to the client
 # example:
 # PORT=8080
+APP_ENV=Development
+APP_DEBUG=true
 APP_NAME=Qaravel
 API_URL=http://qaravel.gomedia/api/
 COOKIE_URL=#

.eslintignore

@@ -1 +1,6 @@
 /dist
+/src-capacitor
+/src-cordova
+/.quasar
+/node_modules
+.eslintrc.js

.eslintrc.js

@@ -1,60 +1,64 @@
 module.exports = {
+  // https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy
+  // This option interrupts the configuration hierarchy at this file
+  // Remove this if you have an higher level ESLint config file (it usually happens into a monorepos)
   root: true,
 
   parserOptions: {
-    parser: 'babel-eslint',
-    sourceType: 'module'
+    ecmaVersion: "2021" // Allows for the parsing of modern ECMAScript features
   },
 
   env: {
-    browser: true
+    node: true,
+    browser: true,
+    "vue/setup-compiler-macros": true
   },
 
+  // Rules order is important, please avoid shuffling them
   extends: [
-    'standard',
+    // Base ESLint recommended rules
+    // 'eslint:recommended',
+
     // Uncomment any of the lines below to choose desired strictness,
     // but leave only one uncommented!
     // See https://eslint.vuejs.org/rules/#available-rules
-    'plugin:vue/essential' // Priority A: Essential (Error Prevention)
-    // 'plugin:vue/strongly-recommended' // Priority B: Strongly Recommended (Improving Readability)
-    // 'plugin:vue/recommended' // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
+    "plugin:vue/vue3-essential", // Priority A: Essential (Error Prevention)
+    // 'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
+    // 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
+
+    // https://github.com/prettier/eslint-config-prettier#installation
+    // usage with Prettier, provided by 'eslint-config-prettier'.
+    "prettier"
   ],
 
-  // required to lint *.vue files
   plugins: [
-    'vue'
+    // https://eslint.vuejs.org/user-guide/#why-doesn-t-it-work-on-vue-files
+    // required to lint *.vue files
+    "vue"
+
+    // https://github.com/typescript-eslint/typescript-eslint/issues/389#issuecomment-509292674
+    // Prettier has not been included as plugin to avoid performance impact
+    // add it as an extension for your IDE
   ],
 
   globals: {
-    'ga': true, // Google Analytics
-    'cordova': true,
-    '__statics': true,
-    'process': true,
-    'Capacitor': true,
-    'chrome': true
+    ga: "readonly", // Google Analytics
+    cordova: "readonly",
+    __statics: "readonly",
+    __QUASAR_SSR__: "readonly",
+    __QUASAR_SSR_SERVER__: "readonly",
+    __QUASAR_SSR_CLIENT__: "readonly",
+    __QUASAR_SSR_PWA__: "readonly",
+    process: "readonly",
+    Capacitor: "readonly",
+    chrome: "readonly"
   },
 
   // add your custom rules here
   rules: {
-    // allow async-await
-    'generator-star-spacing': 'off',
-    // allow paren-less arrow functions
-    'arrow-parens': 'off',
-    'one-var': 'off',
-
-    'space-before-function-paren': ["error", "always"],
-
-    'import/first': 'off',
-    'import/named': 'error',
-    'import/namespace': 'error',
-    'import/default': 'error',
-    'import/export': 'error',
-    'import/extensions': 'off',
-    'import/no-unresolved': 'off',
-    'import/no-extraneous-dependencies': 'off',
-    'prefer-promise-reject-errors': 'off',
+    "prefer-promise-reject-errors": "off",
 
     // allow debugger during development only
-    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
+    "no-debugger": process.env.NODE_ENV === "production" ? "error" : "off"
   }
-}
+};

README.md

@@ -2,25 +2,113 @@
 
 Qaravel is a Combination of Laravel and Quasar
 
-## Install the dependencies
+## 1. Add FontAwesome pro key
+
+We used Fontawesome pro version.
+
+## 2. Install the dependencies
+
 ```bash
 yarn
 ```
 
-### Start the app in development mode (hot-code reloading, error reporting, etc.)
+## 3. Add Configuration
+
+```bash
+cp .env.example .env
+cp .env.frontend .env.frontend.dev
+```
+
+## 4. Configuration for Laravel Sanctum
+
+We have used Laravel Sanctum SPA authentication. Laravel Sanctum provides a featherweight
+authentication system for SPAs (single page applications), mobile applications, and simple, token
+based APIs. Sanctum allows each user of your application to generate multiple API tokens for their
+account. These tokens may be granted abilities / scopes which specify which actions the tokens are
+allowed to perform. Please check laravel default
+[sanctum configuration](https://laravel.com/docs/9.x/sanctum#spa-authentication)
+
+```bash
+SANCTUM_STATEFUL_DOMAINS=qaravel.gomedia:9000 (for local you have to include your port)
+SESSION_DOMAIN=.qaravel.gomedia
+```
+
+## 5. Migrate the Database
+
+Add your database details on .env
+
+```
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=qaravel
+DB_USERNAME=root
+DB_PASSWORD=toor
+```
+
+```bash
+yarn fresh:dev
+```
+
+### Steps for Windows User
+
+Press Win key + R > Paste following in the box > Press Enter
+
+```
+c:\windows\system32\drivers\etc\hosts
+```
+
+Then add thoes line at the bottom and save as admin.
+
+```
+127.0.0.1   api.qaravel.gomedia
+127.0.0.1   app.qaravel.gomedia
+```
+
+### 7. Start the app in development mode (hot-code reloading, error reporting, etc.)
+
+> Only for windows user
+
+```
+php artisan serve --host=api.qaravel.gomedia  --port=80
+```
+
+Change your api url from .env.frontend.dev
+
+```
+API_URL=http://api.qaravel.gomedia
+```
+
 ```bash
 yarn start:web
 ```
 
 ### Build the app for production
+
 ```bash
 yarn build:web
 ```
 
 ### Lint the files
+
 ```bash
 yarn run lint
 ```
 
+### How to deply it in local?
+
+Valet is a Laravel development environment for Mac minimalists. No Vagrant, no /etc/hosts file. You
+can even share your sites publicly using local tunnels. Yeah, we like it too. We used valet to
+deploy this project. Check the configuration of [Laravel Valet](https://laravel.com/docs/9.x/valet)
+
+### How to deply it in web?
+
+First build your app then move all files in server and run following command
+
+```bash
+cp .htaccess.example .htaccess
+```
+
 ### Customize the configuration
+
 See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).