Skip to content

Walkthrough ‐Everything about GHPM

JDX50S edited this page Nov 2, 2023 · 4 revisions

Walk Through

Main app windowScreenshot

[1] - INFO

The Information window where I will be publishing the change notes on each update.

I plan on implementing a few new features to it in the future, stay posted!

[2] - SETTINGS

The Settings Function Includes a number of features that are quite beneficial to the apps experience.

Features:

Some elements of the list are out of date, or were from legacy version. They still serve token purposes and will be updated in coming versions.

Send Logs This New feature makes providing assistance quite easy. If you as the user run into any issues, reach out to me on discord and then send logs.

Push Logs

opt-out

This function offers users the flexibility to control their participation in analytics and error logging. Users can modify this preference at any time. It's important to note that, in compliance with the Terms of Service for the official release, data related to login and downloads is collected, as these are integral to the core functionality of the application. Additionally, initial user information is integrated into the GHPM Account Framework (AF), which mandates Username and Password authentication, along with the inclusion of an email address for enhanced security measures.

Auto Update Enables or Disables the automatic update check (Keep on for best experience)

Advanced Logging Coming out soon

[3] - INSTALL

  1. Begin by specifying the Git repository you wish to access, or alternatively, designate a folder for connection.

  2. Upon hitting the "Submit" button, a list of files will be presented to you. If the repository's readme includes guidance on an entrypoint file (the initial file to execute), please select the indicated entrypoint file. If not, you may need to undertake a manual project setup, in which case you should choose the "Advanced Installation" option.

[4] - ACTIVATE

Once you have successfully downloaded a repository using the Installer, it will be accessible within the Activator. If it was a repository that was installed it will be under the first layer 'GitHub' . If however you connected a local directory you will find it located in the second layer of the Activator interface 'Local'. Finally, if it was a repository installed through an advanced installation you will find it located in the third layer of the Activator interface 'Advanced GitHub Applications'.

GitHub Features:

After you have downloaded and installed a repository using the GHPM client, there are several features available to optimize your GitHub downloads:

  1. Update: This feature enables you to refresh the repository with the latest version from its source. Updating will not change its save location, but it may have varying effects depending on the functionality of the downloaded repository.

  2. Reinstall: The "Reinstall" option permits users to reconfigure either the entry point file or the build instructions of the installed repository. This can be helpful for modifying how the application runs or is built.

  3. Launch: Use the "Launch" feature to initiate the loaded application. This allows you to run the software or application you've downloaded and installed directly from the GHPM client.

[5] - UNINSTALL

Uninstalling is a straightforward process that involves selecting the downloaded repository and confirming the uninstall action. This action will effectively remove all files and components associated with the downloaded project, providing a clean and complete removal.

[6] - COMMAND LINE

The Command Line offers users encountering bugs access to lower-level functionalities of the project. It is also invaluable for debugging, providing users with comprehensive overviews of logs and events in the backend.

[7] - UPDATE LOCAAL

This action enables users to install repositories previously downloaded through their web browser.

[8] - START SERVER

Initiate a connection to the browser and accept incoming requests for installations. This feature allows users to conveniently download repositories through their browser's user interface.

[9] - KILL SERVER

Terminate the connection from the GHPM client to the browser by truncating the connection and no longer accepting incoming requests.

[10] - UPDATE

Update the GHPM client directly from the user interface. Please note that this feature is still under development. Consider enabling Automatic Updates for an enhanced user experience.

[11] - GIT LIST

Effortlessly install any repositories listed; these options come from other GHPM project members or serve as optimizations for the client.

[12] - GHPM RECOMMENDED

The "GHPM RECOMMENDED" feature is your gateway to a dynamically evolving library of repositories and software. It's designed to be a playground for experimentation and exploration, where you can discover new projects, tools, and software that align with your interests and needs.

Currently, this element is at the forefront of our development efforts, holding a high priority on our roadmap. We're committed to delivering a feature that not only suggests but also curates a wide array of projects, ensuring you have access to the most exciting and relevant options. We believe in the power of community-driven recommendations, and GHPM RECOMMENDED embodies this spirit.