Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeoooo/hcdctruesite

"Unofficial" Uptime Status Page for official Holy Cross of Davao College (HCDC) websites.
https://github.com/jeoooo/hcdctruesite

flowbite-react proxy-checker svelte sveltejs sveltekit tailwindcss typescript uptime-monitor

Last synced: 29 days ago
JSON representation

"Unofficial" Uptime Status Page for official Holy Cross of Davao College (HCDC) websites.

Host: GitHub
URL: https://github.com/jeoooo/hcdctruesite
Owner: jeoooo
License: agpl-3.0
Created: 2023-11-03T14:01:21.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-01-09T14:32:19.000Z (10 months ago)
Last Synced: 2024-09-29T11:52:47.531Z (about 1 month ago)
Topics: flowbite-react, proxy-checker, svelte, sveltejs, sveltekit, tailwindcss, typescript, uptime-monitor
Language: Svelte
Homepage: https://hcdctruesite.vercel.app
Size: 1.54 MB
Stars: 8
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # HCDC True Site



  

An "unofficial", third-party uptime monitoring service for official Holy Cross of Davao College (HCDC) websites

![HCDC True SIte](/github%20md%20preview.png 'HCDC True Sight')

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://opensource.org/)

[![Powered by Third Party Service](https://img.shields.io/badge/powered%20by-ThirdPartyService-blue.svg)](https://thirdpartyservice.com/)

[![Follow me on GitHub](https://img.shields.io/github/followers/jeoooo?label=Follow&style=social)](https://github.com/jeoooo)



# Description

HCDC True Site is an unofficial, open-source Uptime Status Checker dedicated to monitoring the availability of key [Holy Cross of Davao College](https://en.wikipedia.org/wiki/Holy_Cross_of_Davao_College) websites.

This project is written in [Svelte](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Svelte_getting_started) and uses [SvelteKit](https://joyofcode.xyz/what-is-sveltekit) as its meta-framework. It conducts routine checks by leveraging [proxy servers](https://www.fortinet.com/resources/cyberglossary/proxy-server#:~:text=A%20proxy%20server%20is%20a,web%20pages%20they%20visit%20online.) to check the uptime of the websites.

# Why create this project?

This project was developed with the primary goal of assisting the HCDC community by providing real-time insights into the operational status of key HCDC websites.

The aim is to empower users with immediate information on whether these essential platforms are accessible or encountering issues. By offering a simple and quick overview, the Uptime Status Checker contributes to a seamless online experience for the HCDC community, ensuring they stay informed and connected.

This project reflects a commitment to enhancing accessibility and transparency for the benefit of the HCDC community.

# Features:

- Real-time Monitoring: Regular checks ensure up-to-the-minute status updates.

- User-Friendly Interface: Easily check HCDC website status with an intuitive design.

- Open-Source: Contribute to the project and enhance its functionality.

# Prerequisites

- [Node.js](https://nodejs.org/en)

- Node Package Manager (NPM)

# Table of Contents

- [Installation](#installation)

- [Contributing](#contributing)

# Installation

Provide instructions on how to install your project. Include any dependencies that need to be installed and how to install them.

```bash

git clone https://github.com/jeoooo/hcdctruesite.git

cd hcdctruesite

npm install

npm run dev

```

This will start a local server at http://localhost:5173/

# Additional Resources

Wanna contribute? Here are the following resources you can use when working on the HCDC True Site codebase:

- Svelte Documentation: [https://svelte.dev/docs/introduction](https://svelte.dev/docs/introduction)

- SvelteKit Documentation: [https://kit.svelte.dev/docs/introduction](https://kit.svelte.dev/docs/introduction)

- Typescript Handbook: [https://www.typescriptlang.org/docs/handbook/intro.html](https://www.typescriptlang.org/docs/handbook/intro.html)

- TailwindCSS Docs (For additional information): [https://tailwindcss.com](https://tailwindcss.com/)

- MDN Web Docs (For additional information): [https://developer.mozilla.org/en-US/](https://developer.mozilla.org/en-US/)

# Contributing

1. Fork it ([https://github.com/jeoooo/hcdctruesite/fork](https://github.com/jeoooo/hcdctruesite/fork))

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

# License

[GNU AGPL v3](https://github.com/jeoooo/hcdctruesite/blob/main/LICENSE)