acx4-server-core v1.0.0

acx4-server-core

Overview

This guide helps to setup development environment for a typical Vasanda server side module.

Setting up dev environment

Node.js

Install node

At the moment we use Node 8 https://nodejs.org/en/download/releases/

Consider using NVM for easier node version management https://github.com/nvm-sh/nvm

Source code style is enforced with https://www.npmjs.com/package/eslint

Install it globally with

npm install -g eslint

Or you can install it within a particular project as

npm install eslint --save-dev

MongoDB

Install or just run local MongoDB server. https://www.mongodb.com/download-center/community

AWS CLI

Install AWS CLI https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html

Configure it for default region 'us-east-2' and provided credentials for API access

GIT

Use any GIT tool based on your convenience. Make sure Linux file ending is used when committing and pushing code to server. Use provided AWS GIT credentials to access remote GIT repo.

Running project locally

To run server module locally, navigate to module root folder and than:

npm i -S

npm start

Logs will be printed to stdout and to log file at

../log/acx-server-<module>.log