feat: add initial boilerplate for services running on web01

Author: cooperj

Writerside/hi.tree

@@ -77,6 +77,13 @@
             <toc-element topic="Logging-In.md"/>
             <toc-element topic="Updates-and-Maintenance.md"/>
             <toc-element topic="Docker-on-socs-web01.md"/>
+            <toc-element topic="web01-services.md">
+                <toc-element topic="Traefik.md">
+                </toc-element>
+                <toc-element topic="Asgard.md"/>
+                <toc-element topic="Yggdrasil.md"/>
+                <toc-element topic="Arcademia-Leaderboard.md"/>
+            </toc-element>
         </toc-element>
         <toc-element topic="socs-nas01.md"/>
         <toc-element topic="socs-nas02.md"/>

Writerside/topics/Arcademia-Leaderboard.md

@@ -0,0 +1,23 @@
+# Arcademia Leaderboard
+
+Arcademia Leaderboard is a hackable leaderboard service to allow our students to quickly and easily develop and deploy games with a shared leaderboard between all the arcade machines.
+
+Arcademia (a play on the words 'arcade' and 'academia') is the name given to the arcade cabinets that have been converted from the Research Arcade project; these are now deployed to allow students to publish and share their games.
+
+The system has been designed with the principal of 'habitability' in the terms of mod-ability and customisation from the students. We provide them full access to the source code - allowing them (if they choose) to open pull requests and issues, allowing for them to understand how the system actually works.
+
+The arcademia project currently is not something that a student is required to take part in for the University degree.  
+
+## Development
+
+The arcademia leaderboard service is an express api, built with Josh's starter template. It is written in TypeScript and runs using Express and Node.
+
+The development documentation is available in the repositories `README`, but a light overview is that;
+
+- The project has been built in a devcontainer, which will automatically launch a `docker compose` file when you open the project in Visual Studio Code. This will provide you with an empty database which you will need to add an initial user account manually, and then create the games that you want to use for testing using an authenticated session state - this is best done using a tool such as [Postman](https://www.postman.com/), a collection has been provided in the repo. 
+
+- And the system has been designed around the idea of 'Model-View-Controllers', however we are removing the 'View' aspect and are directly returning JSON from the controller. Each new controller must have a route, which is registered in the `src/server.ts` file.
+
+## Deployment
+
+Tbd....

Writerside/topics/Asgard.md

@@ -0,0 +1,24 @@
+# Asgard
+
+Asgard is the backend timetabling engine that provides content to [yggdrasil](Yggdrasil.md), 
+it acts as a data aggregator and single point of truth to all display content.
+
+## Development
+
+tbd: discuss the other components and break down into subsections for api/y2/admin/etc.
+
+The asgard api service is an express api, built with Josh's starter template. It is written in TypeScript and runs using Express and Node.
+
+The development documentation is available in the repositories `README`, but a light overview is that;
+
+- The project has been built in a devcontainer, which will automatically launch a `docker compose` file when you open the project in Visual Studio Code. This will provide you with an empty database which you will need to add an initial user account manually, and then create the games that you want to use for testing using an authenticated session state - this is best done using a tool such as [Postman](https://www.postman.com/), a collection has been provided in the repo.
+
+- And the system has been designed around the idea of 'Model-View-Controllers', however we are removing the 'View' aspect and are directly returning JSON from the controller. Each new controller must have a route, which is registered in the `src/server.ts` file.
+
+
+## Deployment
+
+Tbd....
+
+## System Design
+tbd...

Writerside/topics/Traefik.md

@@ -0,0 +1,12 @@
+# Traefik
+
+[Traefik](https://traefik.io/traefik/) is a reverse proxy which runs on the [socs-web01](socs-web01.md) server. This provides ingress to all the web based containers.
+
+This allows us to access the services we are running by using a hostname,  without having to remember an arbitrary port.
+
+For example; you can access [asgard](Asgard.md) with the hostname `asgard.socstech.support`.
+
+But be aware - this will only work if you're connected to the University network, as it is configured only to use a local IP.
+
+> This isn't fully deployed yet and more documentation will be added at a later date.
+{style="warning"}

Writerside/topics/Yggdrasil.md

@@ -0,0 +1,41 @@
+# Yggdrasil
+
+Yggdrasil is the frontend timetable component for the signage screens around the building. It collects its data from [asgard](Asgard.md) and displays the data in the most effective way.
+
+## Development
+
+First, you'll need to clone the repo [SoCSTech/yggdrasil-revamp](https://github.com/SoCSTech/yggdrasil-revamp).
+
+Then you will need to have either **Node 14** installed on your machine (I recommend that you use [nvm](https://github.com/nvm-sh/nvm) for this as we use multiple versions in our day-to-day operations.)
+
+Once you have `nvm` installed, you can install Node 14 with the following commands;
+
+```Shell
+nvm install 14
+nvm use 14
+```
+
+Then you will want to launch the live server with the command:
+```Shell
+npm run dev
+```
+This will allow you to make changes to the project and see the changes happen as you save.
+
+Once you have done making your changes - you will need to commit these changes back to the repo (in your own branch), which will then allow for the project to be signed off and deployed.
+
+### Apple Silicon
+If you're using an ARM based CPU (e.g. Apple Silicon) this won't work without additional steps, as this project is running with node 14 (very old - end of life), and hasn't be upgraded (yet?).
+
+You will need to first install and use [nvm](https://formulae.brew.sh/formula/nvm#default), I recommend you do this with [HomeBrew](https://brew.sh).
+
+Then you need to run the following command to allow your terminal to run in Rosetta mode (64 bit compatibility mode):
+
+```Shell
+arch -x86_64 zsh
+```
+
+Then you can run the commands to use and install node 14.
+
+## Deployment
+
+tbd...

Writerside/topics/web01-services.md

@@ -0,0 +1,4 @@
+# Services
+
+The following section describes the services that are running on SoCS-Web01.
+These typically run in docker and can be managed with `ctop`.