---
# System prepended metadata

title: Installation Requirement For Driver XQ
tags: [Driver XQ]

---

# Installation Requirement For Driver XQ
###### tags: `Driver XQ`

Before setting up the DriverIQ repository, you should ensure that your local machine has PHP and `Composer` installed. If you are developing on macOS, PHP and `Composer` can be installed via `Homebrew`. In addition, we recommend to install Docker desktop depending in what OS you are running in your computer. For example, if you are running Linux install docker for Linux. 

#### **Setting Up the driver-iq repo**

create a file called `auth.json` in the root folder of the driver-iq repo.

Put this as content:

```=json
{
  "http-basic": {
    "spark.laravel.com": {
      "username": "jeremy@littlefox.studio",
      "password": "htdrBA6bxNioHGuP6APX2AO8SrDJrIoi9fQlk3Wo"
    },
    "nova.laravel.com": {
      "username": "phillip@littlefox.studio",
      "password": "sQO28J6DTRsrxWa5hByOuLB5Pfd46T1t0PpQtujAtu2FR2KL5c"
    }
  }

```

After you installed php, composer and Docker desktop on computer you may run this command:

`composer require laravel/sail –-dev` or `./vendor/bin/sail composer install` 

This command allows you to install composer dependencies.

Then you need to create an `.env` file to your driver-iq repo as it’s not tracked in git.

```=env
APP_NAME=DriverXQ
APP_ENV=local
APP_KEY=base64:1BbUxVvRvDFrfQTopj1PhX3aNk8ODY1E0uk4R2wcUeI=
APP_DEBUG=true
APP_URL=http://localhost

LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

DB_CONNECTION=pgsql
DB_HOST=pgsql
DB_PORT=5432
DB_DATABASE=laravel
DB_USERNAME=sail
DB_PASSWORD=password

BROADCAST_DRIVER=pusher
CACHE_DRIVER=file
FILESYSTEM_DISK=s3
QUEUE_CONNECTION=sync
SESSION_DRIVER=database
SESSION_LIFETIME=120

MEMCACHED_HOST=memcached

REDIS_HOST=redis
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="noreply@driverxq.com"
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=sail
AWS_SECRET_ACCESS_KEY=password
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=local
AWS_URL=http://minio:9005/local
AWS_ENDPOINT=http://minio:9005
AWS_USE_PATH_STYLE_ENDPOINT=true

MEDIA_DISK=s3

PUSHER_APP_ID=1367011
PUSHER_APP_KEY=56f04bb3dd3d3c0a8020
PUSHER_APP_SECRET=213f80767e1c121499c1
PUSHER_APP_CLUSTER=ap4

VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

VITE_MAPBOX_ACCESS_TOKEN="pk.eyJ1IjoiYmlncGljdHVyZW1lZGljYWwiLCJhIjoiY2t1NHY0dTBvMXo4NDMxcGc4c3JtbGI4aSJ9.TE07X1eAPUhOtYeb_GGR9g"

NOVA_LICENSE_KEY=sQO28J6DTRsrxWa5hByOuLB5Pfd46T1t0PpQtujAtu2FR2KL5c

CASHIER_CURRENCY=USD
CASHIER_CURRENCY_LOCALE=en
CASHIER_MODEL=App\Models\Team
STRIPE_KEY=pk_test_51KlicHA6BFffkFJD05t2cDoQBbklrPraAujuLoHgyM4ldhc6zwwj4CzshXay5pELK34ZsorjNZtvEJJxowsLw3zu00xhnYBQXJ
STRIPE_SECRET=sk_test_51KlicHA6BFffkFJDu0i14mV8FbGGDQKIsZsZ6lfTqL0GfQ5kHU6NTRF6Ik3xG5QuXS7sxn4HfLUc0PTyOGMO0cr200vpCiASBo
STRIPE_WEBHOOK_SECRET=sk_test_example
SPARK_STANDARD_MONTHLY_PLAN=price_1L2rrRA6BFffkFJDx8i0s3lj

SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://meilisearch:7700
```

To simulate user data run the following seeding command 

`./vendor/bin/sail artisan migrate:fresh –seed` or
`sail artisan migrate:fresh --seed`

You can find all the database details in the `docker-compose.yaml` file 

```=env
DB_CONNECTION=pgsql
DB_HOST=pgsql
DB_PORT=5432
DB_DATABASE=laravel
DB_USERNAME=sail
DB_PASSWORD=password
```

![](https://i.imgur.com/ChYmMyd.png)

Finally you may start Sail by running this command
`./vendor/bin/sail up -d` or 
`sail up -d`

To stop all of the containers, you may simply press `Control + C` to stop the container's execution or use `./vendor/bin/sail stop` command.

Then you may install the npm in your computer by using this command `npm install`.

But make sure you have a node installed in your computer. The node version compatible to run the and install the npm is node **v13.14.0** or the latest version **v16.14.2**. 

You may check your node version and npm version by running this command `node -v` for the version of your node and `npm -v` for your versin of your npm.

Reminder: Always check what node you are installing. 
If you are using mac install node for mac and if you are using windows or ubuntu using wsl2 terminal install node for ubunto or windows.

For the last step, after node and npm are installed, you may run the command `npm run dev` to start your server. And Control + C to stop the server.

### Additional commands you can run to see more detail in the driver-iq repo.
- `php artisan route:list` or `php artisan route:list`
    -  This command allows you to see all the available routes in the repo including the api route list.
- `php artisan route:list --name login`
    - This command allows you to nagivate to in your specific routes you want to see . This example command can show you all the available login routes in the repo.
- `./vendor/bin/sail artisan test`
    - This command allows you to see all the running test script for an available API endpoints.
