-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Vinay Modi
committed
May 12, 2017
1 parent
436b909
commit be7afaf
Showing
1 changed file
with
2 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,3 @@ | ||
| # Microservice Template # | ||
| [](https://travis-ci.org/slidewiki/microservice-template) | ||
| [](https://github.com/slidewiki/microservice-template/blob/master/LICENSE) | ||
| [](https://developer.mozilla.org/en-US/docs/Web/JavaScript) | ||
| [](https://nodejs.org/) | ||
| [](http://hapijs.com/) | ||
| [](https://github.com/slidewiki/microservice-template/blob/master/application/package.json) | ||
| [](https://coveralls.io/github/slidewiki/microservice-template?branch=master) | ||
| # Questions Service # | ||
|
|
||
| This repository contains the template code for a NodeJS based Microservice of the Slidewiki 2.0 project. Please do **NOT** clone this repository and develop your application in it. Instead fork it (following the instructions below) and develop your application there. The CI maintainer ([Roy Meissner](https://github.com/rmeissn)) will setup continuous integration and delivery for your fork. Just notify him. | ||
|
|
||
| Remember to exchange badge urls when forking! | ||
|
|
||
| ## Forking ## | ||
| --- | ||
| Unfortunatly Github doesn't allow someone to fork a repository into the same organization or even transfer ownership after a rename of a forked repository (shame on you, Github!). In order to fork this template, follow these easy steps: | ||
|
|
||
| 1. Create a new repository inside slidewiki organization with your desired name (e.g.: Deck-Service). Don't initiate the repository with a Readme or a license! | ||
| 2. Execute the following commands on your local machine | ||
| 3. Begin your work by altering README.md of your new service | ||
|
|
||
| ``` | ||
| # Clone the Microservice-Template to a folder named after your new service, e.g.: Deck-Service | ||
| git clone [email protected]:slidewiki/Microservice-Template.git NAME_OF_YOUR_NEW_REPO | ||
| cd NAME_OF_YOUR_NEW_REPO | ||
| # Rename the actual origin and add your new repo as the default origin | ||
| git remote rename origin template | ||
| git remote add origin ORIGIN_OF_YOUR_NEW_REPO | ||
| # e.g.: git remote add origin [email protected]:slidewiki/Deck-Service.git | ||
| git push -u origin master | ||
| ``` | ||
|
|
||
| ### Install NodeJS ### | ||
| --- | ||
| Please visit the wiki at [**Install NodeJS**](https://github.com/slidewiki/microservice-template/wiki/Install-NodeJS). | ||
|
|
||
| ### Where to start developing? ### | ||
| --- | ||
| Have a look at the file [application/server.js](https://github.com/slidewiki/Microservice-Template/blob/master/application/server.js), that is the main routine of this service. Follow the **require(...)** statements to get trough the entire code in the right order. | ||
|
|
||
| When you want to have a look at **tests**, head over to the folder [application/tests/](https://github.com/slidewiki/Microservice-Template/tree/master/application/tests). We're using Mocha and Chai for our purposes. | ||
|
|
||
| Since we're developing our application with NodeJS, we're using [npm](https://docs.npmjs.com/) as a **task runner**. Have a look at the [/application/package.json](https://github.com/slidewiki/Microservice-Template/blob/master/application/package.json) script section to obtain an overview of available commands. Some are: | ||
|
|
||
| ``` | ||
| # Run syntax check and lint your code | ||
| npm run lint | ||
| # Run unit tests | ||
| npm run unit:test | ||
| # Start the application | ||
| npm start | ||
| ... | ||
| ``` | ||
|
|
||
| You want to **checkout this cool service**? Simply start the service and head over to: [http://localhost:3000/documentation](http://localhost:3000/documentation). We're using [swagger](https://www.npmjs.com/package/hapi-swagger) to have this super cool API discrovery/documentation tool. BTW.: Did you already discoverd the super easy swagger integration inside [/application/routes.js](https://github.com/slidewiki/Microservice-Template/blob/master/application/routes.js)? Tags 'api' and 'description' were everything we needed to add. | ||
|
|
||
| ### What's about Continuous Integration/Delivery? ### | ||
| --- | ||
| Continuous Integration (and in the future Continuous Delivery) is currently setup by using the (for OSS projects) free to use web application [Snap-CI](https://snap-ci.com/). By clicking on the first badge (see at the top), you will be redirected to Snap-CI. There you can have a look at all the different build stages. | ||
|
|
||
| We've also setup Code Coverage reports. This is done by [Coveralls](https://coveralls.io). Just click on the coverage badge and you'll be redirected to our corresponding Coveralls project. | ||
|
|
||
| In the future, we will exchange Snap-CI with our local instance of Bamboo at the Fraunhofer institute. There will be no changes for you, except that the UI looks a little different. | ||
|
|
||
| ### Use Docker to run/test your application ### | ||
| --- | ||
| You can use [Docker](https://www.docker.com/) to build, test and run your application locally. Simply edit the Dockerfile and run: | ||
|
|
||
| ``` | ||
| docker build -t MY_IMAGE_TAG ./ | ||
| docker run -it --rm -p 8880:3000 MY_IMAGE_TAG | ||
| ``` | ||
|
|
||
| Alternatively you can use [docker-compose](https://docs.docker.com/compose/) to run your application in conjunction with a (local) mongodb instance. Simply execute: | ||
|
|
||
| ``` | ||
| docker-compose up -d | ||
| ``` | ||
| Questions microservice for Slidewiki 2.0 project. |