kaofelix/java-webapp-skeleton

Web Application Skeleton (Java)

Prerequisites

• Java SDK (1.6 or greater use 'javac -version' to check your version)
• Gradle (build tool) ** if you used homebrew to install gradle you need to apply a workaround for the IntelliJ plugin
• IntelliJ Community Edition (IDE)

Getting started

1. Ensure you have installed the Prerequisites

2. Create a new directory for your project and change to it

3. Download the skeleton and start a new git repo by executing:

   curl -L https://github.com/kaofelix/java-webapp-skeleton/tarball/master | tar zx --strip-components=1 && git init

4. Run the build (gradle ideaLibs precommit) to download libraries and make sure everything works

5. Create your first commit ('git add . && git commit')

6. Open the (existing) IntelliJ project

7. Rename the base module (java-webapp-skeleton) to match your project name

8. Rename the package 'your_package' using IntelliJ's rename refactoring to an appropriate package name

9. Go to the 'TO DO' tab and fix the ones marked with 'MAJOR'.

10. Run the build (gradle precommit) to make sure you haven't broken anything

11. Create a commit with your changes ('git add . && git commit')

12. Rename Thingy to be your first domain model object.

13. The remaining 'TO DO' items are numbered and indicate things you should do to familiarize yourself with the code and begin implementing your application