This commit is contained in:
Korbs 2025-01-23 01:47:04 -05:00
parent 7b3b7b386a
commit 6088a97c74
Signed by: Korbs
SSH key fingerprint: SHA256:Q0b0KraMldpAO9oKa+w+gcsXsOTykQ4UkAKn0ByGn5U
12 changed files with 90 additions and 60 deletions

View file

@ -1,6 +1,6 @@
<div align="center">
<img width="128px" src="https://md.sudovanilla.org/images/logos/butterflyvu/ButterflyVu%20-%20Original.svg"/>
<img width="96px" src="https://md.sudovanilla.org/images/logos/butterflyvu/ButterflyVu%20-%20Original.svg"/>
</div>
@ -10,14 +10,17 @@
<center>ButterflyVu is a documentation template built on the Astro Web Framework.</center>
## Running
<br/>
<center><a href="https://nogithub.codeberg.page"><img width="150" src="https://md.sudovanilla.org/images/badges/nogithub/compact.png"/></a></center>
## Development
> `bun` will be used over `npm` in instructions.
### Requirements
- Git
- Bun <span style="font-size: 8px; opacity: 0.5">1</span> <span style="font-size: 8px; opacity: 0.5">2</span>
<p style="font-size: 10px; opacity: 0.5">1. SudoVanilla recommends using the Bun package manager for Astro projects.</p>
<p style="font-size: 10px; opacity: 0.5">2. If you plan to use Bun, NodeJS is not required to be installed, which is why it's not listed as a requirement. If you use i18n in Astro, then NodeJS will be required. (Tested)</p>
- Bun
### Clone Repository
Start by cloning the repository to somewhere on your device using the `git` command:
@ -46,9 +49,9 @@ If the website is not running and an error appears, troubleshoot the problem by
### Requirements
It is expected for the server admin to use the Docker method, as it is recommended, so please install the Docker Engine.
- [Install Docker Engine for Windows]() (WSL Method)
- [Install Docker Engine for macOS]() (Homebrew Method)
- [Install Docker Engine for Linux]()
- [Linux](https://docs.docker.com/engine/install/#supported-platforms)
- [macOS](https://richstone.io/best-way-to-install-docker-on-a-mac/) ([Homebrew](https://brew.sh/), without Docker Desktop)
- [Windows](https://dev.to/felipecrs/simply-run-docker-on-wsl2-3o8) ([WSL2](https://learn.microsoft.com/en-us/windows/wsl/install), without Docker Desktop)
SudoVanilla does NOT recommend using the Docker Desktop application, as it is proprietary software.
@ -58,7 +61,7 @@ A Docker Compose file is provided that can be used without needing to clone the
```
services:
butterflyvu:
image: ark.sudovanilla.org/korbs/butterlyvu:amd64
image: oci.registry.sudovanilla.org/butterflyvu:latest
volumes:
- ./config.json:/app/config.json
- ./docs/:/app/src/content/docs/