Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnavk-09/tila-dashboard
🌸 GitHub actions powered website monitoring/uptime dashboard....
https://github.com/arnavk-09/tila-dashboard
browserless chartjs cms dashboard demo-app deno github-actions-enabled lume-website nunjucks puppeteer static status-page tailwindcss tila uptimerobot workflow
Last synced: about 1 month ago
JSON representation
🌸 GitHub actions powered website monitoring/uptime dashboard....
- Host: GitHub
- URL: https://github.com/arnavk-09/tila-dashboard
- Owner: ArnavK-09
- Created: 2024-04-10T18:57:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-14T05:30:05.000Z (9 months ago)
- Last Synced: 2024-04-14T06:49:28.606Z (9 months ago)
- Topics: browserless, chartjs, cms, dashboard, demo-app, deno, github-actions-enabled, lume-website, nunjucks, puppeteer, static, status-page, tailwindcss, tila, uptimerobot, workflow
- Language: Nunjucks
- Homepage: https://arnavk-09.github.io/tila-dashboard/
- Size: 1.02 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌸 Tila Dashboard 🌸
Effortless Website Monitoring and Incident Management
> [!NOTE]
>
> 🌐 Tila Dashboard is a powerful and user-friendly platform that empowers you
> to monitor your website's uptime, metrics, and incident history. With its
> sleek design and robust features, you can effortlessly manage your online
> presence and keep your users informed.
---
> [!TIP]
>
> ### 🚀 Demo
>
> Experience the power of Tila Dashboard by visiting the
> **[`live demo`](https://arnavk-09.github.io/tila-dashboard/)**
## 📋 Features
- 🕰️ **Uptime Monitoring**: Track the uptime of your website and receive alerts
for any downtime.
- 📊 **Metrics Visualization**: Analyze your website's performance with
interactive charts and data visualizations.
- 📢 **Incident Reporting**: Publish updates and communicate with your users
about any incidents or maintenance.
- 🔒 **Secure and Self-Hostable**: Fully open-source and customizable, with the
option to self-host the dashboard.
- 🥟 **Desktop UI/UX**: Completely desktop friendly and customizable website design,
with support for tailwind css.
## 🛠️ Tech Stack
> Tila Dashboard is built using the following powerful technologies:
- 🦕 [Deno](https://deno.land/) - A modern, secure, and fast runtime for
JavaScript and TypeScript.
- 🔥 [Lume](https://lume.land/) - A Deno-powered powerfull static site
generator.
- 🌙 [Lume CMS](https://lume.land/cms) - Great content management tool that supports GitHub versioning also as well as local
- 🧠 [Nunjucks](https://mozilla.github.io/nunjucks/) - A powerful templating
engine for JavaScript.
- 🎨 [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework
for rapid UI development.
- 🕸️ [Browserless](https://www.browserless.io/) - A cloud-based service for
running headless Chrome and Puppeteer.
- 📊 [Chart.js](https://www.chartjs.org/) - A popular JavaScript library for
creating beautiful data visualizations.
## 🖼️ Screenshots
> Here's a working and expected screenshot of Tila dashboard
| Website Monitor [Online] |
|------------|
|  |
| Website Monitor [Offline] |
|------------|
|  |
| Managing Incidents [CMS] |
|------------|
|  |
| Content Management System |
|------------|
|  |
---
# 🚀 Self-Hosting
> [!TIP]
>
> Tila Dashboard is designed to be easily self-hosted. Follow these steps to set
> up your own instance:
1. **Clone or Use as Template**: Start by either cloning the Tila Dashboard repository directly or use it as a template to create a new repository for your own customized version.
2. **Clear Demo Data**: Before you begin configuring the project, run the command **` deno run -A scripts/delete_data.js `** to clear the demo data from the repository, ensuring a clean slate for your own website monitoring setup.
3. **Configure Uptime Workflow**: Navigate to the **`.github/workflows/uptimer.yml`** file and update it with your website's domain and the desired monitoring schedule in crone date time format. This will set up a recurring GitHub Actions workflow to regularly check the uptime of your website.
4. **Add Your Website Domain**: Either add your website's domain to the `CONFIG.json` file or specify it under the **`WEBSITE_DOMAIN`** environment variable in the **`.github/workflows/uptimer.yml`** workflow. This will ensure that the dashboard tracks the correct website.
5. **Verify Settings**: Run the command **` deno run -A scripts/get_data.js `** to check that your website domain and other settings are correctly configured.
6. **Set Up Browserless Credentials**: Configure the `BROWSERLESS_SERVER_DOMAIN` GitHub repository secret for the Browserless API and authentication `TOKEN`. This will allow the uptime monitoring workflow to securely access the Browserless service.
7. **Enable GitHub Pages**: Enable GitHub Pages for your repository so that the Tila Dashboard can be served as a static website.
8. **Deploy to GitHub**: Commit and push your changes to your GitHub repository. Once the initial workflow run completes, your self-hosted Tila Dashboard will be up and running, ready to monitor and display the metrics for your website powered by GitHub actions.
> [!IMPORTANT]
>
> Remember, these steps guide you through the initial setup process. After completing these steps, you can further customize the Tila Dashboard to meet your specific needs, such as adding more websites to monitor, configuring incident reporting, and exploring the various features of the dashboard.
---
# 🛠️ Local Development
To run Tila Dashboard locally, follow these steps:
1. Clone the repository:
```
git clone https://github.com/ArnavK-09/tila-dashboard.git
```
2. Navigate to the project directory:
```
cd tila-dashboard
```
3. Start the development server:
```
deno run serve
```
4. Open your browser and visit
[**`http://localhost:6969`**](http://localhost:6969) to see the Tila
Dashboard in action.
## 🤝 Contribution
> We welcome contributions to Tila Dashboard! If you'd like to contribute,
> please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.
**We'll be happy to review your contribution and merge it if it aligns with the
project's goals.**
---
## 🌟 Support the Project
If you find Tila Dashboard useful, please consider starring the repository. Your support helps us improve and maintain the project.
> [!WARNING]
>
> - [x] Error status on live demo website is because I haven't hosted browserless otherwise it would show working sign!
> - [x] Current Content Management System of Incidents Managments is set to be on work local environment only and uses [CMS](CMS) Folder for saving data! If you are using in prod. you need to switch to GitHub storage in cms settings, you can take guidance [here](https://lume.land/cms)
---