Merge pull request #14 from growingabit/skelethon

Skelethon project

.codeclimate.yml

@@ -0,0 +1,16 @@
+engines:
+  checkstyle:
+    enabled: true
+    channel: beta
+    config: 'resources/checkstyle.xml'
+  fixme:
+    enabled: true
+  pmd:
+    enabled: true
+    channel: beta
+
+ratings:
+  paths:
+  - "**.java"
+
+exclude_paths: []

.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -1,12 +1,46 @@
-# Compiled class file
-*.class
+############################
+### JetBrains IDEs (all) ###
+############################
+*.iml
 
-# Log file
-*.log
+## Directory-based project format:
+.idea/
 
-# BlueJ files
-*.ctxt
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+###############
+### Eclipse ###
+###############
+
+.settings
+*.classpath
+*.project
+
+############
+### Java ###
+############
 
+*.class
+classes/
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 
@@ -20,3 +54,36 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+#############
+### Maven ###
+#############
+
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+
+############
+### Misc ###
+############
+
+# OS specific files
+*~
+.DS_Store
+
+# Common build folders
+build
+bin
+dist
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt

.travis.yml

@@ -0,0 +1,18 @@
+language: java
+sudo: false
+install: true
+
+branches:
+  only:
+    - master
+
+cache:
+  directories:
+    - '$HOME/.m2/repository'
+
+script:
+  - mvn -f ./pwa-backend/pom.xml clean test cobertura:cobertura
+  - bash <(curl -s https://codecov.io/bash)
+
+notifications:
+  email: false

README.md

@@ -1 +1,18 @@
-# pwa-backend
+# pwa-backend
+
+[![Build Status](https://travis-ci.org/growingabit/pwa-backend.svg?branch=master)](https://travis-ci.org/growingabit/pwa-backend)
+[![codecov](https://codecov.io/gh/growingabit/pwa-backend/branch/master/graph/badge.svg)](https://codecov.io/gh/growingabit/pwa-backend)
+[![Code Climate](https://codeclimate.com/github/growingabit/pwa-backend/badges/gpa.svg)](https://codeclimate.com/github/growingabit/pwa-backend)
+[![Issue Count](https://codeclimate.com/github/growingabit/pwa-backend/badges/issue_count.svg)](https://codeclimate.com/github/growingabit/pwa-backend)
+
+## Contribution
+Please respect our code style.
+We use a sligtly modified version of Google Java Style Guide. You can find useful files to configure your ide or to make code analisys through checkstyle into the resources directory
+
+## useful maven commands:
+
+- `mvn test` to run test (obv :D);
+- `mvn cobertura:cobertura` to run coverage tool. You can see a coverage report navigating into `target/site/cobertura`;
+- `mvn checkstyle:check` to perform a Checkstyle analysis and print violations to the console;
+- `mvn versions:display-dependency-updates` to check for update of dependencies
+- `mvn versions:display-plugin-updates` to check for update of plugins