mirror of
https://gitlab1.ptb.de/waltem01/Matrix
synced 2024-11-15 01:13:49 +00:00
44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
## About
|
|
|
|
This is a Webserver to host a Website on the same machine as the Matrix API. It allows users to access the functions provided by the [API](../API/) and developers to implement new features and interfaces such as games as demos.
|
|
|
|
## Prerequisites
|
|
|
|
Download and install the [LTS](https://github.com/nodesource/distributions?tab=readme-ov-file#installation-instructions) release of NodeJS and NPM.
|
|
|
|
## Installation
|
|
|
|
1. Download repository with `git clone https://gitlab1.ptb.de/waltem01/Matrix.git`
|
|
2. Navigate to the Webserver directory with `cd Webserver/`
|
|
3. Install dependencies with `npm install`
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm run dev
|
|
|
|
# or start the server and open the app in a new browser tab
|
|
npm run dev -- --open
|
|
```
|
|
|
|
## Building
|
|
|
|
To create a production version of the app:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
You can preview the production build with `npm run preview`.
|
|
|
|
## Running
|
|
|
|
1. After finishing the [build process](#Building):
|
|
2. Navigate into the production environment with `cd build/`
|
|
3. Install dependencies with `npm ci --omit dev`
|
|
4. Start the production server with `node .`
|
|
|
|
## Note
|
|
|
|
If the Matrix API is executed on a separate device, although this is explicitly advised against, you will need to point the Webserver to it by setting the optional environment variables shown in [`.env.example`](.env.example).
|