Skip to content

NIC-BizDev/unikitty

Repository files navigation

Build Status

Introduction

The application is deployed to: http://ec2-52-7-51-233.compute-1.amazonaws.com/

The credintials for the prototype are user/password

Getting started

Running the backend with the frontend

You need Java and Maven to be installed. From the command line run mvn spring-boot:run

This should start the application on port 8080. http://localhost:8080/

Running the frontend only

emberjs is the framework of choice.

  1. Install emberjs cli npm install -g ember-cli
  2. Install npm packages npm install
  3. Install bower packages bower install
  4. Run the server ember serve
  5. visit http://localhost:4200

And to run all tests just run ember test

How the code is organized

This is a really simple typical java web application. All the java code is under src/main/java and all the web resources (javascript, css, html, etc) are under src/main/resources/static/

npm Packages

All npm packages are installed in their default location under node_modules.

Bower Packages

bower packages are installed under src/main/resources/static/lib directory.

Contribution

Coding style guidelines

Java

We are using the following style guidelines from google https://google-styleguide.googlecode.com/svn/trunk/javaguide.html

Javascript

We are using the following guidelines from node.js contributers https://github.com/felixge/node-style-guide

HTML and CSS

We are using the following guidelines from google http://google.github.io/styleguide/htmlcssguide.xml

Copyright and license

Code and documentation copyright 2015 NIC Technologies LLC. Code released under the the Apache 2.0 license.