feat: add installation guide to WelcomeModal and README

master
Katja Lutz 2 years ago
parent 1c2af77c65
commit 2ee0672ea5

@ -2,6 +2,18 @@
[<img height="100" src="./assets/icon-large.png"/>](https://rappli.ch)
## Installation
```bash
npm install -g rappli
```
## Running it
```bash
DOMAIN=yourdomain.com rappli
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

@ -618,7 +618,54 @@ const WelcomeModal: Component = (props) => {
label={<div>7. Kann Räppli lokal installiert werden?</div>}
alignCenter={false}
>
test
<p class="!mt-0">
Räppli kann lokal installiert werden, jedoch ist es für den
Betrieb auf Servern optimiert. Das heisst: auch wenn du Räppli
installiert hast, musst du deinen Webbrowser nutzen, um Räppli
zu öffnen.
</p>
<p class="bg-slate-500/10 flex p-3 items-center gap-3 rounded">
<WarningIcon class="w-auto h-6 inline mr-1" />{" "}
<strong>
Für die Installation sind grundlegende Kenntnisse im Umgang
mit der Kommandozeile empfohlen!
</strong>
</p>
<h3>Voraussetzungen:</h3>
<ul>
<li>
Installiere{" "}
<a
class="inline-flex items-center gap-1"
href="https://nodejs.org/en/"
{...externalLink}
>
nodejs {">"}= 18 <ExternalLinkIcon />
</a>
</li>
</ul>
<h3>Installation Räppli</h3>
<p>Führe folgende Befehle aus:</p>
<ul>
<li>
<pre>npm install -g rappli</pre>
</li>
</ul>
<h3>Räppli starten</h3>
<p>Führe folgenden Befehl aus, um Räppli zu starten</p>
<ul>
<li>
<pre>rappli</pre>
</li>
<li>
Sobald die Meldung "Listening on port 3000" erscheint,
kannst du dein lokales Räppli auf deinem Browser über{" "}
<a href="http://localhost:3000" {...externalLink}>
http://localhost:3000
</a>{" "}
erreichen.
</li>
</ul>
</AcordionItem>
<AcordionItem

Loading…
Cancel
Save