HCDC True Site

Description

HCDC True Site is an unofficial, open-source Uptime Status Checker dedicated to monitoring the availability of key Holy Cross of Davao College websites.

This project is written in Svelte and uses SvelteKit as its meta-framework. It conducts routine checks by leveraging proxy servers 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
• Node Package Manager (NPM)

Table of Contents

• Installation
• Contributing

Installation

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

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
• SvelteKit Documentation: https://kit.svelte.dev/docs/introduction
• Typescript Handbook: https://www.typescriptlang.org/docs/handbook/intro.html
• TailwindCSS Docs (For additional information): https://tailwindcss.com
• MDN Web Docs (For additional information): https://developer.mozilla.org/en-US/

Contributing

1. Fork it (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