teamMuseumKiosk

Introduction

This project aims to create a trivia game used for the South Carolina State Museum. The museum intends for the trivia game to implore guests about their knowledge of South Carolina.

For End Users

Tutorial Video

<img src="http://img.youtube.com/vi/7NfmMtrOHU8/3.jpg" alt="teamMuseumKiosk Tutorial Video" width="240" height="180" border="10" />

How to Use App

• Our app has two main components: The trivia section, and the admin section.
• The application loads up on an advertisement screen, which will cycle through the current ads for the museum. Clicking the screen will lead guests to the title screen, where they are introduced to the trivia game and can enter their initials and email. This is also where the admin screen can be accessed.
• If the guest presses continue after entering their information, they will be welcomed to the quiz screen. Guests will go through the game, with the game increasing in difficulty as the quiz goes on. The guest has three strikes: once those three strikes have been reached, or the guest has completed the quiz the guest is greeted with the end screen. Here, the guest can look at past scores, look at their current score, and has the option to play again.
• In the admin section, the admin user is first greeted with a login screen. Once logged in, the admin can choose to add a question, edit or delete a question, or upload an advertisement. If the user clicks on the edit tab, they can choose to edit the amount of strikes in the game, the maximum number of questions used, and which high scores to display. Clicking on the 'Back to Game' button sends the user back to the title screen once again.

Why Use Our App?

Our app was created with the needs of the South Carolina State museum in mind. The app is not created with networking capabilities to better suit the museum's uses. It also allows for images and videos to be used within the questions.

Screenshots

Title Screen

Quiz Screen

End Screen

Admin Dashboard

Admin Edit Screen

About the Team

For Developers

Style Guide

The team will be using the style guide of Google's Java Style Guide.

Run Application

• Download .jar file and TriviaQuestions.csv
• Make sure the jar and trivia files are in the same directory
• Open terminal
• Run the command: java -jar teamMuseumKiosk.jar
• To log into the Admin page - username: museumAdmin password: museumKiosk19

Installing Development Environment (with gradle installed)

1. Install IntelliJ IDE here.
2. Install gradle using a package manager such as Homebrew
   1. homebrew install gradle
3. Git clone this repo: git clone https://github.com/SCCapstone/teamMuseumKiosk.git to directory of your choice or use IntelliJ to clone using "Checkout from Version Control," selecting git and paste https://github.com/SCCapstone/teamMuseumKiosk.git into the URL, and select directory of your choice.
4. Open project in IntelliJ and open "Terminal" tab
5. Write gradle build. Wait until the building process ends and then save & close your project.
6. Reopen your project and click Auto-import, and wait while Gradle is running.

Installing Development Environment (without gradle installed)

1. Install IntelliJ IDE here.
2. Git clone this repo: git clone https://github.com/SCCapstone/teamMuseumKiosk.git to directory of your choice or use IntelliJ to clone using "Checkout from Version Control," selecting git and paste https://github.com/SCCapstone/teamMuseumKiosk.git into the URL, and select directory of your choice.
3. Open project in IntelliJ and open "Terminal" tab
4. Write ./gradlew build. Wait until the building process ends and then save & close your project.
5. Reopen your project and click Auto-import, and wait while Gradle is running.

Test Application

1. Open Terminal in project directory
2. Write ./gradlew test, or if gradle is installed on your computer, gradle test
3. View test results in build/reports/tests/test/index.html