feat: readme
Some checks failed
ci / ci (22, debian-trixie) (push) Failing after 21s

This commit is contained in:
kittentm 2026-05-26 23:18:42 +02:00
commit 6f389786f7
No known key found for this signature in database
GPG key ID: AC43DFDBC1F44A91
2 changed files with 40 additions and 6 deletions

BIN
.github/assets/banner.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 KiB

View file

@ -1,12 +1,46 @@
yea ignore most of the shit the original readme said
# SPBR Website
<p align="center">
<img src="/.github/assets/banner.png" alt="Readme Bannerr" width="100%" />
</p>
use:
```
### This is our official website's source code! Want to contribute? Submit a PR today!
> [!NOTE]
> Please note that some features will not be available, and we are constantly improving the website.
# Setup
Make sure to install the dependencies:
```bash
bun install
```
then to run the app in dev mode do
```
## Development Server
Start the development server on `http://localhost:3000`:
```bash
bun run dev
```
let nuxt init then you're good to go
## Production
Build the website for production:
```bash
bun run build
```
If you encounter issues when building (eg. missing TS config files,) regenerate the stub files:
```bash
bun run nuxi prepare
```
Locally preview the prod build using Bun:
```bash
bun .output/server/index.mjs
```