Dev Setup

Project Structure

Usually, we always work with multiple projects, and each project are typically server + web UI (meaning, Java/Maven on the server, with the webapp/ folder). Here is BriteSnow conventions

• projects/ This is the root for all projects.
  • myFirstProject/ This is the root for a single project.
    • myFirstProject_mvnsrc/ This is the maven source, and this is what is in the git/github, which usually just have the "myFirstProject" as name (and we do a git clone https://github.com/BriteSnow/projectmvc projectmvc_mvnsrc)
      • pom.xml The pom.xml for this project.
      • src/ The default source folder for a maven project.
      • .gitignore which ecludes target/ and other files/directory which should not be shared.
      • myFirstProject_mvnsrc.sublime-project (and the corresponding .sublime-workspace) This is specified in the .gitignore so that it is not shared, but it is a convenient best practice naming/location for the project source project (that points to this myFirstProject_mvnsrc/ folder. This way, switching sublime text project is always clear.)
    • design/ This is where, some member of the teams, put their design documents (Sketch 3 or other .png). This is not designed to be shared (we use dropbox to share eventual file asset with a convension of "project-myFirstProject")
    • war/ This is a simple but powerful way to deploy our web application. In the pom.xml above, on "mvn clean package" the war folder is copied into this folder, which can be put in its own git and pushed to some server for instant deployment. Simple, and very efficient way to deploy exploded war folder.