Merge pull request overture-stack#6 from overture-stack/feature/ci

CircleCI Config

Author: andricDu

.circleci/config.yml

@@ -0,0 +1,41 @@
+version: 2
+jobs:
+  test:
+    docker:
+      - image: circleci/openjdk:8-jdk
+
+    working_directory: ~/repo
+
+    environment:
+      # Customize the JVM maximum heap limit
+      MAVEN_OPTS: -Xmx3200m
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "pom.xml" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: Fetch Maven Dependencies
+          command: mvn dependency:go-offline
+      - save_cache:
+          paths:
+            - ~/.m2
+          key: v1-dependencies-{{ checksum "pom.xml" }}
+
+      # Run Tests
+      - run:
+          name: Maven Test
+          command: |
+            mvn test \
+            -D auth.jwt.publicKeyUrl=$EGO_TEST_SERVER_KEY_URL
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

README.md

@@ -24,11 +24,22 @@ Here is a convenient list of steps to create a new application based on this tem
     - `name`
     - `description`
 3. Update __application.yml__:
-    - `auth.jwt.publicKeyUrl` - URL to fetch the JWT verification key
-4. Update __README.md__: 
+    - `auth.jwt.publicKeyUrl` - URL to fetch the JWT verification key 
+4. Configure Codacy:
+    - Go to [Codacy Project Wizard](https://www.codacy.com/wizard/projects) and add your new repository.
+5. Configure CircleCI:
+    - Go to [CircleCI Add Projects](https://circleci.com/add-projects/gh/overture-stack) and add your project.
+    - Go to CircleCI project settings and modify environment variables
+        - If not there, add new environment variable: `EGO_TEST_SERVER_KEY_URL` . This should store the URL used for `auth.jwt.publicKeyUrl` value in CircleCI tests. 
+6. Update __README.md__: 
     - Replace current README with template - __README.template.md__
     - Remove template file
     - Update Project name and description in new README
+    - Update Shields in Introduction section
+        - Codacy - Badge Markdown code can be found on Codacy project's settings page
+        - CircleCI - Build from example using github organization, project, and branch names
+    
+    
 
 
 ## Requirements

README.template.md

@@ -10,14 +10,19 @@
 - [Introduction](#introduction)
 - [Features](#features)
 - [Requirements](#requirements)
-- [Quick Start](#quickstart)
+- [Quick Start](#quick-start)
+- [Testing](#testing)
+- [API](#requirements)
+- [Acknowledgements](#acknowledgements)
 
 
 
 
 ## Introduction
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e91606af4a364076a7058c5ea1c006a8)](https://www.codacy.com/app/joneubank/microservice-template-java?utm_source=github.com&utm_medium=referral&utm_content=overture-stack/microservice-template-java&utm_campaign=Badge_Grade)
+[![CircleCI](https://circleci.com/gh/overture-stack/microservice-template-java/tree/master.svg?style=shield)](https://circleci.com/gh/overture-stack/microservice-template-java/tree/master)
 
 TODO: Replace with introduction
 
@@ -83,12 +88,12 @@ Application will run by default on port `1234`
 Configure the port by changing `services.api.ports` in __docker-compose.yml__. Port 1234 was used by default so the value is easy to identify and change in the configuration file.
 
 
-## Test
+## Testing
 TODO: Additional instructions for testing the application.
 
 
 ## API
 TODO: API Reference with examples, or a link to a wiki or other documentation source.
 
-## Acknowledgments
+## Acknowledgements
 TODO: Show folks some love.