Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommy141x/os-status-page
A lightweight open source status page.
https://github.com/tommy141x/os-status-page
bunjs react tailwind
Last synced: 3 months ago
JSON representation
A lightweight open source status page.
- Host: GitHub
- URL: https://github.com/tommy141x/os-status-page
- Owner: tommy141x
- License: cc-by-sa-4.0
- Created: 2024-08-04T03:14:26.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T07:11:41.000Z (5 months ago)
- Last Synced: 2024-10-01T03:41:42.841Z (3 months ago)
- Topics: bunjs, react, tailwind
- Language: TypeScript
- Homepage: https://tommy141x.github.io/os-status-page/
- Size: 2.4 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## ✨ Features
- **🔍 Service Monitoring:** Checks response codes of URLs at configurable intervals with a configurable data retention time/history.
- **📊 Charts:** Response times are recorded and displayed on charts.
- **🚨 Incident Management:** Supports incidents of type 'incident' or 'maintenance' with a description and a list of affected services.
- **👤 User Roles:** Admins have full access to the settings, while Managers can only manage incidents.
- **🌓 Dark/Light Mode:** The status page supports both dark and light modes.
This project uses 🐰 BunJS, 🚀 Astro, ⚛️ React, 🎨 Tailwind, and 🧰 ShadcnUI.
## 🚀 Installation and Setup
### 📜 Using the Setup Script (Recommended)
> [!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.
1. **📥 Download the Latest Stable Release:**
- This command will download and open the setup menu, choosing install will also run the BunJS install script.
```bash
curl -O https://raw.githubusercontent.com/tommy141x/os-status-page/main/scripts/setup.sh && chmod +x setup.sh && ./setup.sh
```
2. **⚙️ Configure Settings in (os-status-page):**
- Rename `config.example.yml` to `config.yml`.
- Change the `secret` to a secure value for storing session cookies.
- Edit other configuration settings via the web UI.
3. **🏁 Start with the Setup Script (../setup.sh) & Access the Status Page**
- Default port is `3000`.
- For Docker users, check `docker-compose.yml` for port configuration.
### 🐰 Using BunJS (Without the Setup Script)
1. **📦 Install BunJS:**
- **🐧 Linux & 🍎 Mac:**
```bash
curl -fsSL https://bun.sh/install | bash
```
- **🪟 Windows:**
```powershell
powershell -c "irm bun.sh/install.ps1 | iex"
```
2. **📥 Clone the Repository:**
```bash
git clone https://github.com/tommy141x/os-status-page.git
```
**📝 Note:** Make sure to `cd` into the cloned repository directory:
```bash
cd os-status-page
```
3. **📦 Install Dependencies:**
```bash
bun install
```
4. **⚙️ Configure Your Settings:**
- Rename `config.example.yml` to `config.yml`.
- Change the `secret` to a secure value for storing session cookies.
- Edit other configuration settings via the web UI.
5. **🏁 Start the Application:**
- Run:
```bash
bun start
```
- Alternatively, if using Docker:
```bash
docker compose up
```
- Access the status page at port `3000` by default or the port specified in `docker-compose.yml`.
## 💡 Motivation
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.
## 🤝 Contributing
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.
## 📄 License
This project is open source and available under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/deed.en).
