This project uses 🐰 BunJS, 🚀 Astro, ⚛️ React, 🎨 Tailwind, and 🧰 ShadcnUI.
[!IMPORTANT] It is required to use a bash shell when using the setup script. I'm currently working on a cross platform alternative using bun shell.
The setup script includes an update checker and provides functionality for installing, upgrading, starting, stopping, and viewing the application's logs.
📥 Download the Latest Stable Release:
curl -O https://raw.githubusercontent.com/tommy141x/os-status-page/main/scripts/setup.sh && chmod +x setup.sh && ./setup.sh
⚙️ Configure Settings in (os-status-page):
config.example.yml
to config.yml
.secret
to a secure value for storing session cookies.🏁 Start with the Setup Script (../setup.sh) & Access the Status Page
3000
.docker-compose.yml
for port configuration.📦 Install BunJS:
curl -fsSL https://bun.sh/install | bash
powershell -c "irm bun.sh/install.ps1 | iex"
📥 Clone the Repository:
git clone https://github.com/tommy141x/os-status-page.git
📝 Note: Make sure to cd
into the cloned repository directory:
cd os-status-page
📦 Install Dependencies:
bun install
⚙️ Configure Your Settings:
config.example.yml
to config.yml
.secret
to a secure value for storing session cookies.🏁 Start the Application:
bun start
docker compose up
3000
by default or the port specified in docker-compose.yml
.I created this project because I couldn't find a lightweight status page that was super simple and easy to set up. Additionally, I wanted to try out BunJS and React, as I've never made a full React project before, and I've never used Tailwind.
Contributions to this project are encouraged and appreciated. Please feel free to submit pull requests or open issues if you encounter any problems or have suggestions for improvements.
This project is open source and available under the Creative Commons Attribution-ShareAlike 4.0 International License.