Mirror of https://forge.levinkeller.de/levin/dorfarchiv.git
141ee6795164aa968880489dbc53a69a6c10e1c8
| 1 | # Website |
| 2 | |
| 3 | This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. |
| 4 | |
| 5 | ## Installation |
| 6 | |
| 7 | ```bash |
| 8 | yarn |
| 9 | ``` |
| 10 | |
| 11 | ## Local Development |
| 12 | |
| 13 | ```bash |
| 14 | yarn start |
| 15 | ``` |
| 16 | |
| 17 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 18 | |
| 19 | ## Build |
| 20 | |
| 21 | ```bash |
| 22 | yarn build |
| 23 | ``` |
| 24 | |
| 25 | This command generates static content into the `build` directory and can be served using any static contents hosting service. |
| 26 | |
| 27 | ## Deployment |
| 28 | |
| 29 | Using SSH: |
| 30 | |
| 31 | ```bash |
| 32 | USE_SSH=true yarn deploy |
| 33 | ``` |
| 34 | |
| 35 | Not using SSH: |
| 36 | |
| 37 | ```bash |
| 38 | GIT_USER=<Your GitHub username> yarn deploy |
| 39 | ``` |
| 40 | |
| 41 | If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |