Everything Procedural

Installation

Node.js

Install Node.js from https://nodejs.org

To check of Node (and npm) are installed correctly, open a terminal and run:

npm --version

If you don't get an error, it is installed correctly. Otherwise, rerun the installer and make sure node and npm are added to the PATH environment variable.

Open a terminal in the root folder of this repository and run:

npm install

Scoop

Scoop is used to install the Symfony command line tool that you will need to run a local server for viewing the page during development.

To install Scoop, running the following command in a PowerShell terminal:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser # Optional: Needed to run a remote script the first time
irm get.scoop.sh | iex

Run the following command to see if Scoop is installed correctly:

scoop status

Symfony

The Symfony CLI can be installed using scoop:

scoop install symfony-cli

PHP

Download and install PHP 8.2 from https://www.php.net/downloads

On Windows, you want the VS16 x64 Thread Safe version.

This will give you a ZIP file. Extract the zip file wherever you want, but make a note of the folder you extracted PHP runtime to.

Composer

Download and install Composer from: https://getcomposer.org/download/

During installation, you need to specify the folder where you extracted the PHP zip file to.

Make sure you add Composer and the PHP folder to the PATH environment variable during the installation.

Note: You may need to restart Visual Studio Code to update the PATH environment variable so it can find the composer command.

Open a terminal in the root folder of this repository and run:

composer install

Build

Run the command to generate the build:

npm run build

Generate SSL certs

To generate certificates for the local server, run:

symfony server:ca:install

Serve

To start a local server run:

symfony serve

View

To view the website, open https://localhost:8000