mirror of https://ark.sudovanilla.org/Korbs/butterflyvu.git synced 2024-12-22 23:33:54 +00:00

Find a file

Korbs 7306fcefc8 Update components document		2024-11-14 23:53:12 -05:00
public	update	2024-08-24 00:45:23 -04:00
src	Update components document	2024-11-14 23:53:12 -05:00
.dockerignore	Ditch SSR method	2024-11-12 17:03:52 -05:00
.gitignore	update	2024-08-24 00:45:23 -04:00
astro.config.mjs	Add Pagefind integration	2024-11-14 23:52:50 -05:00
config.json	Convert `.env` to `config.json`. Settle changes.	2024-11-12 14:20:33 -05:00
docker-compose.yml	Fix old names and typos	2024-11-12 17:31:28 -05:00
Dockerfile	Ditch SSR method	2024-11-12 17:03:52 -05:00
package.json	Add Pagefind integration	2024-11-14 23:52:50 -05:00
README.md	Fix old names and typos	2024-11-12 17:31:28 -05:00
TODO.md	update	2024-10-24 14:50:48 -04:00
tsconfig.json	Convert `.env` to `config.json`. Settle changes.	2024-11-12 14:20:33 -05:00

README.md

⚠ This project is new and is under active development. Do not use this in production. Visual designs, logos, assets, and etc are not final. ⚠

ButterflyVu

ButterflyVu is a new 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. (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/

A SudoVanilla Project