Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/santulator/santulator

🎁 A Secret Santa draw generator that creates beautiful PDFs for each participant
https://github.com/santulator/santulator

christmas javafx javafx-application javafx-desktop-apps testfx

Last synced: 13 days ago
JSON representation

🎁 A Secret Santa draw generator that creates beautiful PDFs for each participant

Awesome Lists containing this project

README 

        
# 🎁 Santulator



[![Build Status](https://img.shields.io/travis/Santulator/Santulator/master.svg)](https://travis-ci.org/Santulator/Santulator)

[![Code Coverage](https://img.shields.io/codecov/c/github/Santulator/Santulator.svg)](https://codecov.io/gh/Santulator/Santulator)

[![SonarCloud](/assets/SonarCloud.svg)](https://sonarcloud.io/dashboard?id=io.github.santulator%3Asantulator)

[![Latest Release](https://img.shields.io/github/release/Santulator/Santulator.svg)](https://github.com/Santulator/Santulator/releases/latest)

[![Twitter Follow](https://img.shields.io/twitter/follow/vocabhunterapp.svg?style=social&label=Follow)](https://twitter.com/vocabhunterapp)



Santulator helps you run your Secret Santa draw simply and flexibly.  You can enter the names of the people participating in the draw and the system will randomly choose who will give presents to whom.  If you want to avoid certainly parings, for example to ensure that people don't get their own partners in the draw, you can add exclusions.  When the draw is run, a PDF will be generated for each person telling them who to buy a present for.  If you want to avoid accidentally seeing all of the results, you can add a secret password to the generated PDF files.

[![Santulator draw selection](/assets/Santulator-Draw-Selection-Cards-1.png)](https://santulator.github.io/)

[![Santulator in action](/assets/Santulator-Draw-Wizard-2.gif)](https://santulator.github.io/)



# How To Use Santulator



Santulator is available for free from the [download page](https://santulator.github.io/download/) of the project website.  You can find a complete tutorial explaining how to use the system on the [help page](https://santulator.github.io/help/).



# Running The Development Version of Santulator



You will need JDK 17.  The version used for building Santulator releases is OpenJDK 17 with Hotspot, from [Adoptium](https://adoptium.net).



With your JDK installed you can then clone this repository and run the following to start Santulator:

~~~

./gradlew :gui:run

~~~



# How To Build Santulator



You can build the entire system with the following command:

~~~

./gradlew clean build

~~~



# How To Run The GUI Test



By default the GUI test runs as part of the standard Gradle build, in headless mode.  If you'd like to run the GUI test in a non-headless mode so that you can see what is happening, use the following command:

~~~

./gradlew :gui:test --tests io.github.santulator.gui.main.GuiTest --rerun-tasks -PnoHeadless

~~~



# How to Build The Installable Bundle



[![Installable Java Apps with jpackage](/assets/jpackage-installable-java-apps.png)][Installable Java Apps with jpackage]



In the article [Installable Java Apps with jpackage] you can read about how installable bundles for Mac, Windows and Linux are created and how you can do this in your own project.  These self-contained installers allow users to setup Santulator on their computer without the need to first install Java.



You can also find full, step-by-step instructions for creating the Santulator installable bundle in [PACKAGING.md](package/PACKAGING.md).



# Open Source & Secret Santa with Santulator



[![Open Source & Secret Santa with Santulator](/assets/Open-Source-And-Secret-Santa-With-Santulator.png)][Open Source & Secret Santa with Santulator]



Over on the King Tech Blog you can read more about the project in [Open Source & Secret Santa with Santulator]. The article includes information about how JavaFX CSS is used to give Santulator a festive colour scheme.



[![Before and after colours](/assets/Before-And-After-Colours.png)][Open Source & Secret Santa with Santulator]



[Installable Java Apps with jpackage]:https://vocabhunter.github.io/2021/07/10/installable-java-apps-with-jpackage.html

[Open Source & Secret Santa with Santulator]:https://medium.com/techking/open-source-secret-santa-with-santulator-9101972359fc