Skip to content

Latest commit

 

History

History
59 lines (50 loc) · 2.83 KB

README.md

File metadata and controls

59 lines (50 loc) · 2.83 KB
Raw

Lumitron

Just because we need a little Christmas bling

Task board

View all tasks here --> https://www.pivotaltracker.com/n/projects/1462924

Prerequesites

  1. Eclipse (for development only)
  2. Gradle IDE Pack (for development only) If you already installed the previous Buildship one, I recommend this instead. It is faster to run from eclipse and has less bugs
  3. Gradle (for development only) Not necessary if you run gradle directly from CLI
  4. Java JDK 1.7

Final build is expected to compile into an all-in-one JAR with an embedded webserver

Development Rules

While no one really like to follow rules, let try to keep a few important ones to prevent the code base from becoming a mess

  • Create a new branch when you start something new
    • Follow the following convension
      • feature-YourFeatureName
      • bugfix-FeatureName-FixName
    • Create a pull request when you're done with your work and I'll merge it in if there aren't any issues
      • Please don't merge broken code
  • Comment your code as much as you can
    • Especially if you program like Yoda

Setting up

  1. Clone the project to your local evnironment
  2. Install all prerequsites (or use your existing ones)
  3. Open Eclipse (I'm using Mars) > File > Import
  4. Choose Gradle > Gradle Project
  5. Set the folder Lumitron as the project root > Click Build Model button (top right corner) > Select project > Finish
  6. Go to Window > Preference > Gradle > Set your Gradle home (I'm using v2.8)
  7. Under Gradle/Arguments > Set your Workspace JRE (I'm using 1.7.0_79)
  8. Go to Gradle EnIDE > Set your Gradle home and JAVA_HOME
  9. If its not already there, open the Gradle Tasks view at Window > Show View > Others. Select Gradle > Gradle Tasks
  10. You should be able to see all project tasks in the view. Double click tomcatRun to start the webserver
  • If you are hardcore and like CLI interface, go to the project root and run gradlew tomcatRun Assuming that you have set gradle/bin in your path
  • A few other useful commands
  • tomcatStop - Stop the tomcat server (run from another terminal instance)
  • clean - To clean the build dir
  • build - To rebuild class files
  • war - Packages a WAR file into build/lib
  1. App is accessable at http://localhost:8080/Lumitron
  2. If you have eclipse project issues, go to the Gradle Tasks window abd run the eclipseClasspath task. E.g. If it complains it cannot find class or etc...

Contribuitors

  • Kingston Chan
  • Christophe Michard

Special Thanks

  • Vadim Burlakin
  • Wang Zhiyue

Acknoledgements

Entypo+ pictograms mp3transform