Nexus

This project uses Tailwind, Alpine.js, Laravel and Livewire.

Installation

Cloning This Repository

Clone this repository to your local machine and enter the directory that is created.

git clone git@github.com:VATSIM-UK/nexus.git vatsim-uk-nexus
cd vatsim-uk-nexus

Development Environment

The repository targets PHP 8.0 and Node JS (Currently tested with v12).

If you use VS Code and Docker, our repository contains a dev container configuration that will automatically launch a ready-to-go development environment (including database). Click "Open in Dev Container" when prompted, or run the task from the F1 menu.

If you don't use VS Code, you will need to setup an enviroment with PHP and Node JS (Check out laradock and Laravel Valet). Laravel ships with a handy way to serve the application on a PHP development server. To start, simply run the below command.

php artisan serve

Setting Up Laravel

Generally, this project will follow the standard installation instructions relating to Laravel. The following is an abbreviated guide to get started quickly.

Install the Composer dependencies and create an environment file by copying the example (.env.example).

composer install
cp .env.example .env

Generate an application key.

php artisan key:generate

Compiling Frontend Assets

Install all required dependencies.

yarn

Compile the assets.

yarn dev
``