yoyle.city
+38
src/pages/installation.astro
+38
src/pages/installation.astro
···
1
+
---
2
+
import Layout from "../layouts/Layout.astro";
3
+
---
4
+
5
+
<Layout>
6
+
<h1>Installation</h1>
7
+
<h2>Prerequisites</h2>
8
+
<ul>
9
+
<li>A computer</li>
10
+
<li><a href="https://nodejs.org/">Node.js</a> or <a href="https://bun.sh/">Bun</a> installed</li>
11
+
<li>Medium terminal knowledge</li>
12
+
</ul>
13
+
<h2>Installing dependecies + running the app</h2>
14
+
Run <pre>npm i</pre> if you are on Node.js or <pre>bun i</pre> if you are on
15
+
Bun.
16
+
<br />
17
+
After that, run <pre>npm start</pre> (or <pre>bun start</pre>) and you
18
+
should be able to access Skittr on port 3000!
19
+
<h2>Environment variables</h2>
20
+
<ul>
21
+
<li>
22
+
<pre>PORT</pre> - the port that Skittr will be listening on other than
23
+
3000 (which is used by default)
24
+
</li>
25
+
<li>
26
+
<pre>PUBLIC_URL</pre> - the public URL of your Skittr instance, it's
27
+
recommended to set it up if you plan on hosting it on the public network
28
+
</li>
29
+
<li>
30
+
<pre>SESSION_SECRET</pre> - the session secret used for cookies, it's
31
+
a randomized string so feel free to type any string value to it. You
32
+
can even use a keyboard smash!
33
+
<br />
34
+
If the value is not supplied, the session secret will be automatically
35
+
generated by the server, but it's temporary.
36
+
</li>
37
+
</ul>
38
+
</Layout>