Skip to content

admin/dorfarchiv

PublicMirror

Mirror of https://forge.levinkeller.de/levin/dorfarchiv.git

57 lines · 1.8 KB
1# Digitales Dorfarchiv Rössing
2
3Dieses digitale Archiv dokumentiert die Geschichte und Geschichten aus Rössing. Die Website wurde mit [Docusaurus](https://docusaurus.io/) erstellt, einem modernen Static-Site-Generator.
4
5## Lizenzierung
6
7Dieses Projekt verwendet ein Doppellizenz-Modell:
8
9### Inhalte (Content)
10
11- **Standard-Lizenz**: Alle Inhalte des Archivs (Texte, Bilder, Dokumente) stehen unter der [**CC0 1.0 Universal (Public Domain)**](https://creativecommons.org/publicdomain/zero/1.0/deed.de), sofern nicht ausdrücklich anders angegeben.
12
13- **HAWK-Projektunterlagen**: Die Unterlagen des HAWK Studienprojekts (Projektdokumentation, Karten, CAD-Dateien) wurden von den Autorinnen Lea von Berg, Felina Freiberg, Caroline Rabe und Charlotte Schemm erstellt und stehen unter der [**Creative Commons Namensnennung 4.0 International (CC BY 4.0)**](https://creativecommons.org/licenses/by/4.0/deed.de).
14
15### Source Code
16
17Der Quellcode dieser Website (alle `.ts`, `.tsx`, `.js`, `.jsx`, `.css` und Konfigurationsdateien) ist unter der [**MIT-Lizenz**](./LICENSE) lizenziert.
18
19**Zusammengefasst**: Sie können die Inhalte frei verwenden (CC0/CC BY 4.0) und den Code frei nutzen, modifizieren und verteilen (MIT).
20
21## Installation
22
23```bash
24yarn
25```
26
27## Local Development
28
29```bash
30yarn start
31```
32
33This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
34
35## Build
36
37```bash
38yarn build
39```
40
41This command generates static content into the `build` directory and can be served using any static contents hosting service.
42
43## Deployment
44
45Using SSH:
46
47```bash
48USE_SSH=true yarn deploy
49```
50
51Not using SSH:
52
53```bash
54GIT_USER=<Your GitHub username> yarn deploy
55```
56
57If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.