Giter Site home page Giter Site logo

varpedia's Introduction

VARpedia - SOFTENG 206 Project

Group 12 - Di Kun Ong (dngo711) & Tudor Zagreanu (tzag747)

Check out the VARpedia GitHub: https://github.com/dikunong/VARpedia
Our project devlog can be accessed in the file DEVLOG.md, or at: https://github.com/dikunong/VARpedia/wiki/Development-Log

VARpedia is an encyclopedia tool that provides visual, aural and reading capabilities for a second language learner, young adult (18-25 years).

Running the JAR file

On Windows AND On Linux (incl. Beta Linux in UoA labs)

For marking purposes, this should be tested on the Beta Linux image on the lab computers.

As stated above, the target audience of this app is a second language learner, young adult (18-25 years).

NOTE: VARpedia is dependent on an ffmpeg version of at least 4.x. Some lab computers have an older version 2.x, which will not work. Before marking, please check your computer's ffmpeg version using the following command:

ffmpeg -version

Execute the following command:

java -jar VARpedia.jar

On SOFTENG 206 VirtualBox Image ONLY

A script file has been provided for running the JAR in the VirtualBox. It assumes that the JAR file has been moved out of /build/libs and into the root directory.

./run_varpedia_vbox.sh

NOTE: If you are building your own JAR and wish for dev builds in IntelliJ and the production JAR to access the same /creations folder, move the JAR file from /build/libs to the root directory.

Building the JAR file

Execute the following command:

gradlew.bat shadowJar

This will produce a runnable JAR file in /build/libs.

Note that there's a weird issue where Gradle can't find your JDK install - if this happens, you need to manually set it by creating a gradle.properties file in the root directory, with this line in it:

org.gradle.java.home=HOME_DIRECTORY

where HOME_DIRECTORY is your JDK install directory e.g. C:\\Program Files\\Java\\jdk1.8.0_202

Flickr API

VARpedia makes use of the Flickr API to download publicly available images for use in user creations.

If you wish to run this application from the source code or build it yourself, you will need to supply your own Flickr API keys in the following location:

src/main/resources/varpedia/key.txt

This file should have the apiKey on the first and the sharedSecret on the second line. There should be no labels or other text in the file, like below:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxx

Attribution

Libraries

Flickr4Java

Available at https://github.com/boncey/Flickr4Java

SLF4J (used by Flickr4Java)

Available at http://www.slf4j.org/

Music

src/main/resources/varpedia/music/perspective.mp3

Music "another perspective" by panu featuring airtone, onlymeith
Available at ccMixter.org http://ccmixter.org/files/panumoon/60396
Under CC BY NC license http://creativecommons.org/licenses/by-nc/3.0/

src/main/resources/varpedia/music/chinese.mp3

Music "mandolin chinese (moscardo remix)" by moscardo
Available at ccMixter.org http://ccmixter.org/files/moscardo/60170
Under CC BY NC license http://creativecommons.org/licenses/by-nc/3.0/

src/main/resources/varpedia/music/sirius.mp3

Music "Sirius Crystal" by Speck featuring Sascha Ende, Apoxode
Available at ccMixter.org http://ccmixter.org/files/speck/60126
Under CC BY license http://creativecommons.org/licenses/by/3.0/

varpedia's People

Contributors

dikunong avatar pisucat avatar tzag747 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.