node package manager

event-track

Record any actions your system perform, along with any properties that describe the action.

Event Track

Codeship Status for rafaeljesus/event-track Docker Image Size Docker Image Pulls NPM version bitHound Overalll Score bitHound Dependencies bitHound Dev Dependencies bitHound Code

  • Record any actions your system perform, along with any properties that describe the action.

Installation

npm install -g event-track

Running tests

To run a suite tests execute:

npm test

Built with

  • nodejs Backend is a node-v.5.3.0.
  • koa API is a KOA app. It respond to requests RESTfully in JSON.
  • Mongodb Mongodb as a data store.

Docker

This repository has automated image builds on hub.docker.com.

Use docker-mongodb and run command described there

Finally run:

$ docker-machine start default
$ eval $(docker-machine env default)
$ docker run -it -e "NODE_ENV=development" -v "$(pwd)":/data --link mongo:mongo -w /data -p 3000:3000 rafaeljesus/event-track
$ curl `docker-machine ip default`:3000

Run a command in the container

$ docker exec -it image_id bash

API documentation

We use source code comments to add documentation.

You can browse an HTML documenation at /apidoc/index.html

Contributing

  • Fork it
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create new Pull Request

Maintaners