Korbs/butterflyvu
1
Fork 0
Code Issues Pull requests Activity

update

Browse source
This commit is contained in:
Korbs 2024-06-06 17:51:12 -04:00
parent 0c6d1ebd06
commit cd91e6c10e
3 changed files with 56 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -1,10 +1,63 @@
<div style="background: #f1e05a; color: black; padding: 12px 24px; border-radius: 6px;">
⚠ This project is new and is under active development. Do not use this in production. The project name is also subject to change. Visual designs, logos, assets, and etc are not final. ⚠
</div>
# <center>Project Pandora Butterfly</center>
<center>Project Pandora Butterfly is a new documentation template built on the Astro Web Framework.</center>
<br/>
## Running
> `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>
> Project name is subject to change and not production ready.
<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. (Tested)</p>
### Clone Repository
Start by cloning the repository to somewhere on your device using the `git` command:
```bash
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:
```bash
bun install
```
### Run
Run the website with the run command:
```bash
bun start
```
The website should start running at [http://localhost:2014](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:
pandora-charm:
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.
___
<center>A <a href="https://sudovanilla.org/">SudoVanilla</a> Project</center>

BIN
bun.lockb
View file

Binary file not shown.

17
src/pages/index.astro
View file

@ -1,16 +1 @@
---
---
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
<meta name="viewport" content="width=device-width" />
<meta name="generator" content={Astro.generator} />
<title>Astro</title>
</head>
<body>
<h1>Astro</h1>
</body>
</html>
<p>Demo</p>