Configure WhiteSource Bolt for GitHub

.env.example

@@ -0,0 +1,13 @@
+NODE_ENV=develop
+
+PROTOCOL=http:
+HOSTNAME=localhost
+PORT=3000
+
+DB_USER=
+DB_PASS=
+DB_HOST=localhost
+DB_NAME=towns
+DB_PORT=27017
+
+GIT_SSH_KEY=LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlKS0FJQkFBS0NBZ0VBcnhjb292cWVnR1habFdzSXArUE1pQ2pTbXVrRnlPM1FjNUEzRUpWNUhFalA1VkVpCnlZaTUveGlEMjhQUGtTTFlBOURCUnIrbm45Wnl0MnlROUN4WHIxaE94MERZSEZLaGZRRWNFM0sxTmhvOFRZSmYKd2ZuMGUvV1hMdmNKbVluaDczUWlweDBJM1R2Y0lQSGR6MkpYYTVrbDZnd21TRms0U2doRWpqbDBMV2FjZDYvbgo5bU5jdHZwZ21McDFDU01iRlc4UXRhVGF4MUp1dFJKMEgvUnFCTHlGWHRDT01OU1Q2dWZsREkydzFKenQvY2c2Ckw4cnMvclNJUEphOGNhdlR4U1JjK05iMXl4N1YzVXRQaW9nb0MzQmRkTnBiWnhVWTVNYTRheDZOMUIvRUxVS2kKcm1rTzhCK0IvelNpS3N1aDVnUE5nd3M4aWlwUG5xZ3hJYWc2WkRSN0hydXVFNmU1Vktpanlkb1o2eHI4by9CZAp2bXIxYm05c2pGM01SWk1nTm54VGRiMS93a3RMT0ZPem5ab0s1WlR3VSsrOGNZa2E0MkNVSXNWUzlCdVJnLzA1CnF6WDJOdlFPcThSSCtpcVkwUHhkaDRuZzRLb25ZcEVGVXdWejIxeE9iRFpQYUZLTXVCa3RIVmdMdnpWM0dTalgKeDh4OVAwMEZ1eFdLL2pWR01aWEdqV1AzZy9mUmtOKzd2NGFIUnZMMEZ5RjU0c2RMZWtkMWdIUm1SVnRvbVRMNQpWeFM5M2QrMFJId3lvQVl5T2VDYk12VGwvdXdBSUJPdS9BRzB4UkxlVythNjZaKzRhSnhERTFSSkdvRFpXUFRNClhpWFhyZjVXaWdLbmhZZkJVQklRWW5udDFpd1FhMVFubUtlVFRMWXdPOElwWUlJM1k1Z2dIZTI3RUI4Q0F3RUEKQVFLQ0FnQUxRV3plVlVnZEx1NzIyUU9jYjF0MW9WSXduU3cvQjNLd0N5UlBENXpTZ2FmRHNSeVFZaGE2M0dPVgpuQmZhMTZlVlR6VXRqQ0tGZHU2MjllYTNtNllqWW9UbDhEZzBVZWVKdHFtTVlvSmRzUUFSWjRFcVlod2lYOTVSCktaWlhaWEs5eHZSM1U3bC9KMXIyVHpZWUg5VkkySGFFZmpWenp6QjhLZDNtV3JFcVBmOXUva0xtSnVzTjVEaVQKZU9FUExrK09hQzVsenV3MWhnb1IzOWJST3hBWnI5alBDSThyZW03cjJlNXlpU1ZGOWJTaTdOMDR0MDNXN2RvWQpNd1I0TmppTjR0R0xPWjVoYVdFTU1jd3lOcUNFWTd2T1NEODUrRFE2ZUwvZ092MlpGbFd4SnloNEY4N2JCdHQvCmdXMnZYSm5TeEluUWs4ZFhobkxKMnp3VlV0QTJCNTJieloydS9oalhFRDArT3FxdjM0VUxBZVFRVWYyZmJQVHEKMTNaVzlBVER1aHN1NnYzc3NENG1lNUlPN0dWQ25rdkdRNlFqSkpuNWhQNkFnbWl3N0ZyWUt6d0ZyMENOblBqaQpQNXpSMEZNR2FVTjNuMWhQQWZuZjF6ZktYUzRnNk40ck1UbkxEektBQnpXN3RPaC8zd2h3N0NBYmZucWNucXRBCmF0ckV6aHY4MWNvbmFyTE5IUzROSndqN1VmL0FtK2FySDE3U0FIWlBqUm12OUFjRVQ5cENpSUtLaVVORFN6U3QKZVpaSVMzYnlrajY4RVZKNE85SXBnUlVrMFV1Z0RGR1NXMDJpVUE0WWJRQXFKRWpXS2NuQUd1QkhJSlRCZkt6eQphaXpMNHFtVEdST25KMjNnbElsT3l6QmE2V0pXajAwbHI4QnNqdTNLZWpJdVhLQitpUUtDQVFFQTNkNXRHSXB1ClVaZERDeVpYSS9laGI3VnNhRUh3ZjNkNy95cHRRclJzWGlHOS9rK0o3L3k2NVdyaE9zYmdGR0xPQkFQc0FYQ1oKbUZMRmZFYzY4M0d1OHo2R2VLbE55S2IrUW52V2EwVkU0TzlpN1diRlB6T1czNy9ENkVEZHlzVzYzcnZnTjlXZgo3a0Myd25TdWRSalBhZ043NGl3R3lRTm5RL1JiL3Q5eHJ3LzMxUm54Yng2WldMV0NHL0QrdVFmY2R0UWNvZ2ZCClMzR242VEZqN3pQQlFsOFJtZ2dhMG9ST1B2OXFVcmFBTkFWY0h0dzFmcitFWVlwNVhXZEZKOXNvQ09rTHNoSVEKdmNiUHRDS1RmQzVjbXhaNnZhcHNtTWNkaTVHU2ZXenl5c3g4Y0d4S25IVDZwK1JEQkpaUjQxc3VDTWdMejJ2ZAozUm1zeHdlcW9KQkZBd0tDQVFFQXlnYUZGVmkzaExCTzYrc0oxbmMwRmMyWWRHcXA0aU5DNm43R3lzLy84KzYvCmlKZ0FrdEsxMTVOOWRPT1lmVEwvbDFjeUVZUGhuaklrbzNhdVNBM3BabytaNjV2TEpwQzd5b1I2eDFxNnp2ME8Kd3pLOWdMTlgzdU8ySzE5UGpxQmpnNFhJWHFxZXRVTC9tQjRKUCtma0dIdFZpaTJoWVdrL3pjVUwxY00wK0dhSgpYZzN3NmZVUHozZktwSTBPUjBQVWVwYkZjci9pOEs1KytZRWRraFRJR2RwcDlWdzlEMysxd2w4aUYwVXpWM28zCmpnUmRLVzdnUGgyVmdEaW1tYWZ5dUZCck1WRnVRcGhPS1N0dHBmbW9weDVUSmdqWkFzV3kwSkFvUHZqeHIxRXoKOXNsekFhK0xkdTdEOVhIcWV6bmlxZ1dnMnJ0TjBjR3hPaTJBY0MwWHRRS0NBUUVBdFFjRUdzN3dmbEFlR3QzWQpvZmN0MkhpK0VEOGxITXYvOTAzRnduUjJLMFA2d3FKaFdOZnNJcjVYTVY4TmZIUzF4Wjd4bEtjc0c1WUZub1o3CitpQmE4QXVuS3BKeGJmT2JaK0dsTFBkaTRPbFIzWVJLRW14a2dRSDF0ZTRmU1pDV0RhQmJyUkwzb0MxYk1VU0YKQi9RTFlHT2hWQVE2TVE4KzFicHV5WUhGUDJLWEEyQmNseDd2WGVzVFV2c0t5eXczM1JqcWwrWWQrQkd2UUZ6VgpQbG9MS0wxckhqUFl0c1hQRmlYT3VkaEF1TEZhM2E4dFV0S3ZEK3N0WldHYWtvK0ZsZWVZYkYzREhTVTNXYklRCmhuVkppQjBLWHZETUZNZjZPbU8zay9FdUZQeE4yR2p6WTc4cXVZeE1obFNrVWc2V2ZBSEZhU09JN2h0QjEwOVIKRUJ0R3d3S0NBUUFybDE2TjdaZWpwTnRTb21OOENEcVAzYzNnaU1kaFNSUitQcDZzVWxjN0RpLzd6RGlMZGJYUQo3ejBweEpZNXBaQnEybUN1VU5PVTYrTGw5b3pDZFdZQVFFb0pBWlBESFlXM3ZBQTJGY2lyTXdWRmJ5UmVxZFB5Ci94Vm1wR2twTUVob3I2dzlhUGxYeVQ0WFY1dk5Vejd2WFdWbXJGUGZEZk83ZGFJSkhOYklKbS9MZ0p5VUR0RzcKaFhDUE12UjZ3aE1ONUl4MEp4MVRxNE13V1FERmJZQ0R1NUlUWkRTMHJHek9wUEpaTFJCWDlzSVgvYThRYXFFdQpKZm9GTWJRWkFaa28xZ2xiR2VQOXNKbGszcjhKQ2lhdThLY21WTkJtZmJ3SXJxSlFmQ3pDRkhadThLYkZIVml0CmIvV09kMmNOOGI2THl5MGJKVUUwV21QZ1ZzTVk4VkhsQW9JQkFIQkVhZG50RDIvZi94emxjRk54SFdFVEJSR3EKOGEveFNzNGpobDAzV04rWTBXY2I3ejVOVHJqMnlEYnhBRFZuNGhYTGRWWHZZMmFRM0tSbUNNeW9sQjdoUDhaOAo5Tk5Tcm1URU5zU3pLUk03MHJrekV4VXRVY2EzMzA0aUN6QVFZS2tKeDI0THViUmZWSXpVN3VlcUEvYVFDMEU0Cmo0Rmc2SnFHZUtFWkEwRGVKcGJ5L3VkWklsNU1tQm15UVMzVFFrMW0vclVQZHJNaXVKY25YNTVoSGUyNFY1V2QKSTh4aVcvK1VkcEsvY1JSQjlNZGJsQ3VrNEVwOEJUNytLMSs1VTJwZDh3akRwSmNORFdtb05oSWl0NitEQm1Fbwo3eEpwM2NBdis1dG00OTluNTRMN2l2WWdEdjJpSkcvdTNtM1dxYlNNOEM5WUtoOENWOHRLa1NSL0hqUT0KLS0tLS1FTkQgUlNBIFBSSVZBVEUgS0VZLS0tLS0K

.gitignore

@@ -0,0 +1,15 @@
+.idea/
+node_modules/
+
+npm-debug.log
+
+#my helper files, which shouldn't be in repo
+asd.*
+
+# shared library is in different repository
+towns-shared/
+
+.env
+.env.test
+
+database/backup/*.tar

.whitesource

@@ -0,0 +1,12 @@
+{
+  "scanSettings": {
+    "baseBranches": []
+  },
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure",
+    "displayMode": "diff"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

Makefile

@@ -0,0 +1,4 @@
+test:
+	@./node_modules/.bin/mocha --reporter spec
+
+.PHONY: test

README.md

@@ -0,0 +1,144 @@
+# Towns backend
+
+
+## Organization
+
+https://trello.com/townsgame
+
+https://trello.com/b/beAsHIkG/backend
+
+
+## Authors of backend
+
+**[SK] Stefan Kecskes:** https://www.skey.uk
+
+**[PH] Pavol Hejný:** http://pavolhejny.com
+
+
+## Folder Structure
+
+    [towns5]/                       <- root folder
+	├── [bin]/                      <- all shell scripts for app
+	|   └── www                     <- shell starter for node server
+	├── [config]/                   <- central folder with all configurations
+	|   ├── db.js                   <- settings for mongoDb connection
+	|   └── server.js               <- settings for api server
+	├── [controllers]/              <- controllers for routes
+	|   ├── [api]/                  <- json api controllers
+	|   |   └── *.js       
+	|   ├── [http]/                 <- html controllers
+	|   |   └── index.js     	         
+	|   └── [middleware]/           <- middlewares
+	|       └── *.js            
+	├── [database]/                 <- data related classes
+	|   ├── [backup]/               <- DB backups and backup script
+	|   ├── [migrations]/           <- schemas and seeds for mongoDB collections    
+    |	|   └── 00xy-*.js     
+	|   ├── [models]/               <- collection models for mongoose
+	|   |   └── *.js                <- all models sits here
+	|   ├── [schemas]/              <- Schemas are partials of collections 
+	|   |   └── *.js                
+	|   ├── [seeds]/                
+	|   |   └── *.js                <- seeded data
+	|   └── [services]/             <- model helpers
+	|       ├── mongoose.js         <- mongoose wrapper around DB 
+	|       └── validation.js       <- validations of models are here
+	├── [layouts]/                  <- view templates for pages
+	├── [public]/                   <- publicly accessible folder for node server 
+	|   └── [css]/
+	|       └── style.css
+	├── [routes]/                   <- routes
+	|   └── *.js
+	├── [test]/                     
+	|   └── *.js                    <- tests for mocha.js
+	├── .env                        <- environment variables (copy from .env.example and fill in details)
+	├── .gitignore                  <- files ignored but git
+	├── apiary.apib                 <- backup of API documentation from apiary 
+	├── gulpgile.js                 <- configuration for linter testing
+	├── Makefile                    
+	├── package.json                <- npm packages
+	└── server.js                   <- express starter
+
+
+## Requirements
+
+- Linux Server
+- Node.js (with npm)
+- mongoDB
+
+
+## Installation
+
+We will assume that you already have installed **globally node and npm**.
+
+1. Go into api folder and install the necessary node modules (express framework, etc) with npm: `npm install`
+
+2. copy .env.example to .env file and fill in the required details
+
+
+## Launching
+
+### Production and testing environment
+
+Towns 5 Api server is node.js application and can be launched with command:
+
+	npm start
+
+In case you use node manager like pm2, then go to root folder of project and run
+
+	pm2 start ./bin/www
+
+### Develop environment
+
+In case you need to debug it or on develop environments set environment variable DEBUG=api:* This is set differently on
+Mac, Linux or windows. We also use nodemonitor, which detects changes in files and automatically restarts node.
+
+For for debugging on Linux and Mac use this
+
+	npm run start-debug
+
+or for Windows use this
+
+	set DEBUG=api:* & npm start
+
+Api will be accessible on http://localhost:3000
+
+Tip: Consider using [pm2](https://www.npmjs.com/package/pm2) for running node server as service or managing multiple instances on one server
+
+## Migrations
+
+The code has some default objects and schemes, which should be migrated into applications mongoDB.
+
+Run new changes in mongoDB schemas and seed new migrations (if necessary) by running: 
+
+    npm run mongo-migrate
+
+You can easily backup current DB (using current the .env). It will be saved in folder like this: `/database/backup/db-20160412-1649.tar` by running:
+
+    npm run mongo-backup
+
+DEVELOPERS ONLY: In case you want to drop all collections and create them again from migration collection use:
+
+    npm run mongo-remigrate
+
+## Testing
+
+Node loads automatically environment variables from .env file, therefore it have to be set to test environment. 
+
+    npm run start
+
+### with Linter
+
+You can run tests for javascript syntax errors with linter, just run
+
+	gulp test
+
+
+### with Mocha
+
+Test files are in `test` directory. You can run [Mocha](https://mochajs.org) testing framework with BDD style
+[should.js](https://github.com/shouldjs/should.js) assertion library. Basically any assertion which throws error
+will work. Don't forget that node with API must be running to be able to test.
+
+	npm test
+