Go to file
2024-06-10 21:38:11 -04:00
public update 2024-06-08 16:20:59 -04:00
src update 2024-06-10 21:38:11 -04:00
.dockerignore Ignore node_modules 2024-06-07 03:14:40 -04:00
.gitignore New project name is final 2024-06-07 07:09:39 -04:00
astro.config.mjs Don't run Keystatic in production and export vars 2024-06-07 03:15:10 -04:00
bun.lockb update 2024-06-10 21:38:11 -04:00
config.json Make menu links configurable 2024-06-10 21:36:01 -04:00
docker-compose.yml New project name is final 2024-06-07 07:09:39 -04:00
Dockerfile Install packages with Bun 2024-06-07 03:15:36 -04:00
keystatic.config.ts New project name is final 2024-06-07 07:09:39 -04:00
package.json update 2024-06-10 21:38:11 -04:00
README.md Fix typeo 2024-06-07 07:16:06 -04:00
TODO.md update list 2024-06-10 21:37:42 -04:00
tsconfig.json Import utils and enable AllowJS 2024-06-07 03:16:20 -04:00

⚠ 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 is a new documentation template built on the Astro Web Framework.


bun will be used over npm in instructions.


  • 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/project-pandora-charm/
cd ./project-pandora-charm/

Install Packages

Install required packages so you can run the project:

bun install


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.



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.

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.

    image: ark.sudovanilla.org/korbs/project-pandora-charm:amd64
    port: 2014:2014

While simple and small, it is expected this will expand in the future and an all-in-one solution will be provided.

A SudoVanilla Project