Baipyrus/Matrix
1
0
Fork 0
mirror of https://gitlab1.ptb.de/waltem01/Matrix synced 2024-11-08 22:43:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
cd31c576ec
Matrix/Webserver/README.md
waltem01 159255836f README explaination for .env
2024-01-11 13:18:48 +01:00

1.1 KiB
Raw Blame History

About

This is a Webserver to host a Website on the same machine as the Matrix API. This allows users to access its functions and developers to implement new features and interfaces such as games as demos.

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

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:

npm run build

You can preview the production build with npm run preview.

Running

  1. Navigate into the production environment with cd build/
  2. Install dependencies with npm ci --omit dev
  3. Start the production server with node .

Note

If the Matrix API is executed on a separate device, although this has been explicitly advised against, you will need to point the Webserver to it by setting the environment variables shown in .env.example.