INSTALL.md

INSTALLING THE PROJECT

These instructions cover set-up for a local environment, for details about other environments see the release docs.

All commands listed should be run from the local repo's root directory.

Requirements

• Composer
• Git
• Node.js with NPM

Windows Only (Pre-installed on MacOS)

• PHP running via Apache or Nginx
• MySQL

The recommended options for this are Laragon or Xampp.

Installation

Dependencies

Once the repo is forked and then cloned to a local repository, install the project's dependencies by running the following:

$ composer i
# Installing dependencies from lock file (including require-dev)...

$ npm i
# up to date, audited... // Exact message depends on the state of the local environment

Environment Configuration

Then create the local Dotenv with:

$ cp .env.example .env && php artisan key:generate
# INFO  Application key set successfully.

Review the properties in the local Dotenv to ensure they are set-up to match the desired environment.

Database Initialisation

Ensure a local database file exists with:

$ touch database/database.sqlite
# ... {creates the file if it doesn't exist}

Set-up the app's database with the default content found in the seeds directory with:

$ php artisan migrate --seed
# INFO  Preparing database...

---

Next
................................................................................................... >>> Project CLI Commands >>>