Project DESTINY

Description

Project DESTINY  is an unofficial, open-source Uptime Status Checker dedicated to monitoring the availability of key websites and student portals across Davao City.

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. The backend of this project uses Pocketbase.

Features:

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

• User-Friendly Interface: Easily check website status with an simplistic design.

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

Prerequisites

• Node.js
• Node Package Manager (NPM)
• Pocketbase (v20.0.0+)

Table of Contents

• Installation
• Contributing

Installation

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

cd PROJECTDESTINY

npm install

npm run dev

1. Execute pocketbase.exe from the root folder.

2. Run the pocketbase instance using the following command

./pocketbase serve

this will open a pocketbase instance at http://127.0.0.1:8090 just like the example below

2023/12/31 06:47:32 Server started at http://127.0.0.1:8090

├─ REST API: http://127.0.0.1:8090/api/

└─ Admin UI: http://127.0.0.1:8090/_/

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/
• Pocketbase Documentation: https://pocketbase.io/docs/

Contributing

This is the updated way to contribute after migrating from Pocketbase to JSON for managing school data.

1. Fork the repository by navigating to https://github.com/jeoooo/hcdctruesite/fork.
2. Create a new branch for your feature (git checkout -b my-new-feature).
3. Open the static/schools.json file in the repository.
4. Add a new entry for the school you want to contribute in the following format:

{
    "name": "Mock School",
    "acronym": "MS",
    "logo": "mock_school_logo.png",
    "websites": [
        {
            "type": "official_website",
            "url": "https://www.mockschool.edu.ph/",
            "display_url": "mockschool.edu.ph",
            "website_description": "The official website of Mock School"
        },
        {
            "type": "student_portal",
            "url": "https://studentportal.mockschool.edu.ph/login",
            "display_url": "studentportal.mockschool.edu.ph",
            "website_description": "The official student portal of Mock School"
        },
        {
            "type": "lms",
            "url": "http://lms.mockschool.edu.ph/",
            "display_url": "lms.mockschool.edu.ph",
            "website_description": "The official Learning Management System (LMS) of Mock School"
        }
    ],
    "description": "Mock School is a fictional educational institution providing high-quality education.",
    "hex_code": "#336699"
}

Description of JSON Keys:

• name: The name of the school.
• acronym: (Optional, can be removed) The acronym or abbreviation of the school's name.
• logo: The filename of the school's logo image (accepted image formats: jpg and png).
• websites: An array containing information about the school's websites, including their type, URL, display URL, and description.
  • type: The type of website (e.g., official website, student portal, LMS).
  • url: The URL of the website.
  • display_url: The display URL shown to users.
  • website_description: A description of the website.
• description: A brief description of the school.
• hex_code: The hexadecimal color code representing the school's branding color.

1. Fill in the details for the new school, including its name, acronym, logo filename, website URLs, description, and hex code.
2. Save the changes and commit them with a descriptive message (git commit -am 'Add Mock School').
3. Push your changes to your forked repository (git push origin my-new-school).
4. Create a new Pull Request by visiting https://github.com/jeoooo/hcdctruesite/compare and selecting your branch.
5. Provide a clear title and description for your Pull Request, summarizing the changes you've made.
6. Submit the Pull Request for review.
7. Once reviewed and approved, your changes will be merged into the main repository.

> [!IMPORTANT]
> To contribute or suggest schools you may submit [a GitHub Issue](https://github.com/jeoooo/PROJECTDESTINY/issues)

# License
[MIT license](https://github.com/jeoooo/PROJECTDESTINY/blob/main/LICENSE)