No description

Find a file

Korbs 0f7b1eba40 Remove		2024-12-11 20:59:07 -05:00
public	update	2024-08-24 00:45:23 -04:00
src	Remove	2024-12-11 20:59:07 -05:00
.dockerignore	Fix docker	2024-12-01 00:24:26 -05:00
.gitignore	Ignore .tar files that is generated	2024-12-10 22:59:48 -05:00
astro.config.mjs	Add Pagefind integration	2024-11-14 23:52:50 -05:00
bunfig.toml	Install from SudoVanilla Registry	2024-12-11 20:42:09 -05:00
config.json	Fix configuration sample	2024-12-11 20:42:00 -05:00
docker-compose.yml	update	2024-12-11 11:54:26 -05:00
Dockerfile	Run as preview, don't start as dev	2024-12-11 20:41:52 -05:00
LICENSE	Add license	2024-12-11 00:55:20 -05:00
package.json	Bump	2024-12-11 20:49:07 -05:00
README.md	update	2024-12-11 15:07:48 -05:00
TODO.md	Update TODO	2024-12-11 20:42:22 -05:00
tsconfig.json	Fix docker	2024-12-01 00:24:26 -05:00

README.md

ButterflyVu

ButterflyVu is a documentation template built on the Astro Web Framework.

Running

bun will be used over npm in instructions.

Requirements

Git
Bun 1 2

1. SudoVanilla recommends using the Bun package manager for Astro projects.

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)

Clone Repository

Start by cloning the repository to somewhere on your device using the git command:

git clone https://ark.sudovanilla.org/korbs/butterflyvu/
cd ./butterflyvu/

Install Packages

Install required packages so you can run the project:

bun install

Run

Run the website with the run command:

bun start

The website should start running at http://localhost:2014.

If the website is not running and an error appears, troubleshoot the problem by reading the error and try again. If the problem persist, submit an issue.

Hosting

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

SudoVanilla does NOT recommend using the Docker Desktop application, as it is proprietary software.

Docker Compose (Recommended)

A Docker Compose file is provided that can be used without needing to clone the repository. Download the file to it's folder somewhere on your disk and run it.

services:
  butterflyvu:
    image: ark.sudovanilla.org/korbs/butterlyvu:amd64
    volumes:
      - ./config.json:/app/config.json
      - ./docs/:/app/src/content/docs/
      - ./dists/:/app/dist/

  nginx:
    image: nginx:latest
    restart: always
    ports:
      - 4242:80
    volumes:
      - ./dists/:/usr/share/nginx/html/

Overriding Components

Since ButterflyVu is written in Astro and the site is built during each startup in Docker, overriding the components is easy. Now for, overriding the header will be shown, it's pretty much the same basics for other components.

This also works for any other part of ButterflyVu, such as for the layouts and styles. This will be expanded on once the ButterflyVu documentations are written on it's own site, ironic that it hasn't been built yet, right?

Header

In the docker-compose.yml file, add a path to the volumes section to your custom header:

  - ./components/Header.astro:/app/src/components/global/Header.astro

The file must be an .astro file, anything else like .jsx will not work.

If you already have the custom header written and it's ready for showtime, just run the Docker image again and the new header will be built with the site.

A SudoVanilla Project