µCtrl-Server

This repository contains the core components of the Server service released under the µCtrl source project.

To know more about what this server does and how it's made, visit our Jira Confluence

Getting started

Prerequisites

• Node.js - Download and Install node.js. You can also follow this gist for a quick and easy way to install Node.js and npm
• MongoDB - Download and Install MongoDB - Make sure it's running on the default port (27017).

Quick Install for Macintosh users

There's a script in script/bootstrap-mac. It will make you have Homebrew, Node.js and MongoDB installed. If not, it will install them. After, it will install all dependencies, so the only command to run is gulp. You might (or not) need to Download and Install gulp yourself.

Start the server

Clone the repo:

git clone [email protected]:uCtrl/Server.git

Install dependencies:

$ npm install

Then you can gulp to start the server:

$ gulp

Gulp offers you file monitoring and other useful services, but you can start without it:

$ node server.js

Use/Interact with the server

The server exposes routes to interact (CRUD) with the BD and handles the push/pull of data to NinjaBlocks. To test it, make an account on NinjaBlocks and get your API token. Then, make a POST Request on http://localhost:3000/users with the following JSON Data:

{
  "ninjablocks" : { 
    "userAccessToken": "107f6f460bed2dbb10f0a93b994deea7fe07dad5"
  }
}

Now that your user is created in the server, you can make a GET Request on the System: http://localhost:3000/system.

For more infos, either go on our confluence or dig in this repo.

Enjoy.