Baipyrus/Matrix
1
0
Fork 0
mirror of https://gitlab1.ptb.de/waltem01/Matrix synced 2024-11-12 16:03:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

better SvelteKit app README

Browse Source
This commit is contained in:
waltem01 2023-12-01 08:06:10 +01:00
parent c93d1f9479
commit 2cf0b376f3
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Webserver/README.md
View File

@ -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 .`