Matrix/Webserver/README.md

## 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).
better SvelteKit app README 2023-12-01 07:06:10 +00:00			`## About`
initialize sveltekit webserver 2023-11-23 12:22:59 +00:00
improve and update documentation 2024-03-15 08:18:35 +00:00			`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.`
initialize sveltekit webserver 2023-11-23 12:22:59 +00:00
nodejs/npm installation instruction 2024-04-04 13:25:11 +00:00			`## Prerequisites`

			`Download and install the [LTS](https://github.com/nodesource/distributions?tab=readme-ov-file#installation-instructions) release of NodeJS and NPM.`

better SvelteKit app README 2023-12-01 07:06:10 +00:00			`## Installation`
initialize sveltekit webserver 2023-11-23 12:22:59 +00:00
better SvelteKit app README 2023-12-01 07:06:10 +00:00			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`
initialize sveltekit webserver 2023-11-23 12:22:59 +00:00
better SvelteKit app README 2023-12-01 07:06:10 +00:00			`## Development`
initialize sveltekit webserver 2023-11-23 12:22:59 +00:00
			```bash
			`npm run dev`

			`# or start the server and open the app in a new browser tab`
			`npm run dev -- --open`
			```

			`## Building`

better SvelteKit app README 2023-12-01 07:06:10 +00:00			`To create a production version of the app:`
initialize sveltekit webserver 2023-11-23 12:22:59 +00:00
			```bash
			`npm run build`
			```

			You can preview the production build with `npm run preview`.

better SvelteKit app README 2023-12-01 07:06:10 +00:00			`## Running`

improve and update documentation 2024-03-15 08:18:35 +00:00			`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 .`
README explaination for .env 2024-01-11 12:18:48 +00:00
			`## Note`

improve and update documentation 2024-03-15 08:18:35 +00:00			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).