Skip to content

ThomasFinnern/JoomGallery_fith

 
 

Repository files navigation

JoomGallery

This is the repository of the JoomGallery component for Joomla! 4 and newer.

Project-Website: https://www.joomgalleryfriends.net/

Support-Forum: https://www.forum.joomgalleryfriends.net

Non-binding roadmap (DE): https://www.forum.joomgalleryfriends.net/forum/index.php?thread/483-unverbindliche-roadmap/&postID=2880#post2880

Project Presentation (DE): https://docs.google.com/presentation/d/1kXGfGRrHswU0M3yh0zUvOwW1fYqB07cksHzNxzcEyxI

Translation

Translated with Crowdin

Crowdin

Want to donate?

JoomGallery is an OpenSource project and is developed by users for users. So if you are using JoomGallery feel free to contribute to the project...

Literature

The JoomGallery component is developed following the current Joomla! 4+ Paradigm. Following you find some online resources explaining them.

Joomla 4 extension development docs


Contribute code

Just like the CMS Joomla!, the gallery component JoomGallery is an Open Source project and exists because of its community. Which means that everything in the project is developed and maintained by users of the JoomGallery. Therefore we ask you to use your skills and knowledge to contribute to the project. Here on GitHub you can help coding and developing the extension.

Following the JoomGalleries coding documentation:

Setup development environment

https://docs.joomla.org/Setting_up_your_workstation_for_Joomla_development

Webserver recommendation:

IDE/Editor recommendation:

Git-Client recommendation:

Recommendet approach for proper versioning with Git:

  1. Checkout the repo into a folder of your choice
  2. Download the source code of the dev-branch as zip file and install it on Joomla
  3. Remove the installed component folders within your Joomla installation
    • administrator/components/com_joomgallery
    • components/com_joomgallery
    • media/com_joomgallery
    • plugins/finder/joomgallerycategories
    • plugins/finder/joomgalleryimages
    • plugins/privacy/joomgalleryimages
    • plugins/webservices/joomgallery
  4. Create symbolic links from those folders to the corresponding folders within the checked out copy of the repository
  5. The referenced copy of your component can be properly versioned using Git

Symbolic link generator tool for windows: https://schinagl.priv.at/nt/hardlinkshellext/linkshellextension.html


Testing

Testing is an integrate part of the development process and can be done even without coding skills. Just look at the tab Pull requests to see which code changes need testing. If you want to test a code change, this is how to do it:

  1. Open the Pull request (PR) you want to test
  2. Scroll down the comments feed of the PR all the way to the bottom
  3. Open the accordion All checks have passed
  4. Open the link PR Build Artifact / build-pr-zip
  5. Change on the left navigation to Summary
  6. Click the link in the Artifacts section which has the name "JoomGallery-PRname"
  7. A zip file of the PR gets created and downloaded
  8. Install the zip file in your Joomla!
  9. Perform tests where the PR changes anything
  10. If you find a bug or unexpected behaviour, post a comment in the pull request with the following content:

Issue reporting

Steps to reproduce the issue

List the steps to perform in order to reproduce the issue you found

Expected result

What would you have expected should have happen?

Actual result

What did really happen?

System information

  • PHP-Version
  • Database type and version
  • (ImageMagick version)

Additional comments

Anything else that you think is important for the developer to fix the issue

About

A native image gallery component for Joomla! Finnern

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 94.4%
  • JavaScript 4.2%
  • Other 1.4%