ajay-sagittaire / fibserver

REST web service for fibonacci, demonstrating Pivotal Cloud Foundry, Spring Boot and AngularJS

README for fibserver

See the wiki for background on this project.

Introduction

fibserver is a simple REST server implemented with Spring, for calculating fibonacci sequences. It also comes with an AngularJS front end to demonstrate calling the REST server. It's all glued together with JHipster, which provides monitoring and maintenance screens and other features.

These technologies were chosen specifically for their focus on extensibility and maintainability in a production environment, the key requirement of the project. To learn more about the technology choices, please see Technology Choices.

Support Documentation

The front end for the application looks like this: Type a number between 0 and 200 in the input to print out a fibonacci sequence.

How To See Health Checks

An authenticated user can see health checks for a running instance of the server.

How To Test API Methods

Authenticated users can test calls to the REST services:

How To Check Metrics

An authenticated user can view metrics for a running instance of the server.

This will also show number of server errors per HTTP request.

How to Obtain Timings for a Web Service Call

It may be useful to check the performance statistics for services in production. Authenticated users can check service time in milliseconds for getFibonacciSequence on the Metrics page, Services Statistics section.

How To Manage the Application on Cloud Foundry

The application is deployed to the EMC Pivotal Cloud Foundry where it can be managed, e.g.

• View the logs
• Scale the application by adjusting number of instances
• Adjust memory available to the instances

Developer Documentation

Install Prerequisites

These instructions apply to OSX 10.8.2.

1. Install Java from the Oracle website.
2. Install Maven
3. Install Git if not already installed
4. Install Node.js from https://nodejs.org/
5. Install Yeoman: sudo npm install -g yo
6. Install Bower: sudo npm install -g bower
7. Install Grunt: sudo npm install -g grunt-cli
8. Install JHipster: sudo npm install -g generator-jhipster

How to Build the Application

1. Check out the project : git clone https://github.com/lucrussell/fibserver
2. Run mvn spring-boot:run (or run src/main/java/com/mycompany/myapp/Application.java in your IDE)
3. Browse to http://localhost:8080

How To Deploy to Cloud Foundry

1. Create an account on Pivotal Cloud Foundry
2. Install the cf CLI here
3. Run yo jhipster:cloudfoundry

Development Notes

Here are a few key parts of the application:

• FibonacciServiceTest.java: Unit test for the FibonacciService.
• FibonacciService.java: This contains the business logic for the calculation.
• FibonacciResource: Exposes the service to POST requests with a REST API.
• main.controller.js: AngularJS file backing main.html. Makes calls to the REST service.
• main.html: HTML page to interact with the service.

How To Run The Tests

You can run mvn:test on the command line, or run all the tests under src/main/test in your IDE.

Troubleshooting

Grunt tests might fail. Ensure they can run by setting up PHANTOMJS_BIN env var, see here.