joaopapereira / asyncvoter

For Voting on Stories and Tickets remotely and asynchronously e.g. planning poker

AsyncVoter

For Voting on Stories and Tickets remotely and asynchronously e.g. planning poker

Table of content

• Install
• Configure
• Run
  • Application
  • Unit tests
• Troubleshooting

Install

In order to install this application you need first to ensure that you have NPM installed With Node.JS version 6.8 or higher

To install the application get the code

git clone https://github.com/AgileVentures/AsyncVoter.git

Inside the folder AsyncVoter run the following command

npm install

At this point we have all the dependencies installed and we are ready to start

Configure the application

Please create a .env file (if you don't have one already) and copy the contents from .env.sample. This is needed before running your application.

... We will need to fill this up with mongo db connection info

If you are unsure what this means just: cp .env.sample .env

Running the application

After the configuration is done we can start the application using

npm start

Running tests

To run all the Chai/Mocha tests execute

npm test

To use the new cucumber tests execute:

npm run cucumber

Troubleshooting

Mocha not installed error

If you get this error try cleaning the cache using

npm cache clean

ES6 Support

If you are experiencing errors like:

Block-scoped declarations (let, const, function, class) not yet supported outside strict mode

Make sure that the version of node is >= 6.8

node -v

Adding REST routes

Top-level routing is now handled in the src/routes.js file. For domain-level sub-routes please use an appropriate routing file in the domain folder.

Please see src/routes.js and src/story/story.routes.js for examples of how it is done.