diff --git a/Webserver/README.md b/Webserver/README.md index 5c91169..5091841 100644 --- a/Webserver/README.md +++ b/Webserver/README.md @@ -1,22 +1,14 @@ -# create-svelte +## About -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +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. -## Creating a project +## Installation -If you're seeing this, you've probably already done this step. Congrats! +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` -```bash -# create a new project in the current directory -npm create svelte@latest - -# create a new project in my-app -npm create svelte@latest my-app -``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +## Development ```bash npm run dev @@ -27,7 +19,7 @@ npm run dev -- --open ## Building -To create a production version of your app: +To create a production version of the app: ```bash npm run build @@ -35,4 +27,8 @@ npm run build You can preview the production build with `npm run preview`. -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +## 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 .`