vspaceone/web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

move readme to root

Browse Source
This commit is contained in:
Enrico Bühler 2024-06-29 18:42:14 +02:00
parent 6f03c60d5a
commit 1437dd3b60
2 changed files with 54 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -1,2 +1,55 @@
# web # vspace.one - Website
Dies ist das Repository mit dem Quellcode der vspace.one Webseite.
## Tech-Stack
Das Projekt nutzt als Basis die ["Astro"]("https://astro.build") Framework.
Als Laufzeit empfehlen wir ["Bun"]("https://bun.sh"), es sollte allerdings auch möglich sein Node.js zu verwenden.
### Wieso nicht React, Vue oder XYZ...?
Ziel ist es die Seite vielen Menschen zugänglich zu machen.
Bisher nutzt die Seite ausschließlich Astro Komponenten, welche vom Prinzip her eine Abstraktion über HTML sind, und sehr nah am Web-Standard im Vergleich zu vielen anderen Frameworks.
Allerdings ist es in Astro auch problemlos möglich mit bspw. React zu arbeiten. Dies funktioniert über ["Islands/Inseln"]("https://docs.astro.build/de/concepts/islands/").
Hierbei handelt es sich um Inseln die in dem Projekt eingebetteten werden (Sinnbildlich, nicht zu verwechseln mit iframes). In diesen Islands können React, Vue.js sowie viele weitere libraries verwendet werden.
Ziel ist es soweit wie möglich mit Astro auszukommen, da wir hierdurch zu großen Teilen auf Client-Seitiges JavaScript verzichten können, was die Bundle Size klein hält und die Ladezeiten schnell.
Grundsätzlich bleibt es euch aber offen eure Lieblings-Library zu verwenden, solange es nicht auf der Startseite ist.
## Entwickeln des frontends
Die Befehle müssen im Unterordner /web ausgeführt werden.
### Installieren der Abhängigkeiten
Bun:
```bun install```
Node.js/NPM:
```npm install```
### Starten des Entwicklungsservers
Bun:
```bun dev```
Node.js/NPM:
```npm start```
### Kompilieren
Bun:
```bun run build```
Node.js/NPM:
```npm run build```
### Kompilieren
Hinweis: Hierfür muss erst die Seite kompiliert werden.
Bun:
```bun preview```
Node.js/NPM:
```npm preview```

55
web/README.md
View File

@ -1,55 +0,0 @@
# vspace.one - Website
Dies ist das Repository mit dem Quellcode der vspace.one Webseite.
## Tech-Stack
Das Projekt nutzt als Basis die ["Astro"]("https://astro.build") Framework.
Als Laufzeit empfehlen wir ["Bun"]("https://bun.sh"), es sollte allerdings auch möglich sein Node.js zu verwenden.
### Wieso nicht React, Vue oder XYZ...?
Ziel ist es die Seite vielen Menschen zugänglich zu machen.
Bisher nutzt die Seite ausschließlich Astro Komponenten, welche vom Prinzip her eine Abstraktion über HTML sind, und sehr nah am Web-Standard im Vergleich zu vielen anderen Frameworks.
Allerdings ist es in Astro auch problemlos möglich mit bspw. React zu arbeiten. Dies funktioniert über ["Islands/Inseln"]("https://docs.astro.build/de/concepts/islands/").
Hierbei handelt es sich um Inseln die in dem Projekt eingebetteten werden (Sinnbildlich, nicht zu verwechseln mit iframes). In diesen Islands können React, Vue.js sowie viele weitere libraries verwendet werden.
Ziel ist es soweit wie möglich mit Astro auszukommen, da wir hierdurch zu großen Teilen auf Client-Seitiges JavaScript verzichten können, was die Bundle Size klein hält und die Ladezeiten schnell.
Grundsätzlich bleibt es euch aber offen eure Lieblings-Library zu verwenden, solange es nicht auf der Startseite ist.
## Entwickeln des frontends
Die Befehle müssen im Unterordner /web ausgeführt werden.
### Installieren der Abhängigkeiten
Bun:
```bun install```
Node.js/NPM:
```npm install```
### Starten des Entwicklungsservers
Bun:
```bun dev```
Node.js/NPM:
```npm start```
### Kompilieren
Bun:
```bun run build```
Node.js/NPM:
```npm run build```
### Kompilieren
Hinweis: Hierfür muss erst die Seite kompiliert werden.
Bun:
```bun preview```
Node.js/NPM:
```npm preview```