diff --git a/.github/assets/banner.png b/.github/assets/banner.png new file mode 100644 index 0000000..c0796b2 Binary files /dev/null and b/.github/assets/banner.png differ diff --git a/README.md b/README.md index 3f1d8d0..2df6a84 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,46 @@ -yea ignore most of the shit the original readme said +# SPBR Website +

+ Readme Bannerr +

-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 \ No newline at end of file + +## 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 +``` \ No newline at end of file