https://github.com/jroliveira/planning-poker-api

A Planning Poker (api)(🃏) powered by Koa and Socket.IO.
https://github.com/jroliveira/planning-poker-api

babeljs es7 javascript koa2 mongodb nodejs socket-io web-api

Last synced: 4 days ago
JSON representation

A Planning Poker (api)(🃏) powered by Koa and Socket.IO.

• Host: GitHub
• URL: https://github.com/jroliveira/planning-poker-api
• Owner: jroliveira
• Created: 2015-06-23T03:17:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-10-24T12:34:51.000Z (about 6 years ago)
• Last Synced: 2024-11-16T05:41:58.794Z (2 months ago)
• Topics: babeljs, es7, javascript, koa2, mongodb, nodejs, socket-io, web-api
• Language: JavaScript
• Homepage: https://planning-poker-api.herokuapp.com
• Size: 31.3 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Planning Poker (api)

[![Code Climate](https://codeclimate.com/github/planning-poker/planning-poker-api/badges/gpa.svg)](https://codeclimate.com/github/planning-poker/planning-poker-api)

[![bitHound Overall Score](https://www.bithound.io/github/planning-poker/planning-poker-api/badges/score.svg)](https://www.bithound.io/github/planning-poker/planning-poker-api)

[![bitHound Code](https://www.bithound.io/github/planning-poker/planning-poker-api/badges/code.svg)](https://www.bithound.io/github/planning-poker/planning-poker-api)

[![bitHound Dependencies](https://www.bithound.io/github/planning-poker/planning-poker-api/badges/dependencies.svg)](https://www.bithound.io/github/planning-poker/planning-poker-api/master/dependencies/npm)

[![Build Status](https://travis-ci.org/planning-poker/planning-poker-api.svg?branch=master)](https://travis-ci.org/planning-poker/planning-poker-api)

![Planning Poker (api) - Logo][logo]

Api da app mobile híbrida de planning poker.

### Installing

``` bash

$ git clone https://github.com/planning-poker/planning-poker-api.git

$ npm install

```

#### Configuration file (.env)

```json

{

  "marinet": {

    "url": "",

    "app": {

      "id": "",

      "key": ""

    }

  }

}

```

### Running tests

``` bash

$ npm test

```

### How to use it

``` bash

$ npm start

```

### Docker

* Create a docker image:

  ``` bash

  $ sudo docker build -t planning-poker-api .

  ```

* Create a container based on the image:

  

  $ sudo docker run -d -p 5000:5000 -v <path-to-dot-env>:/app/.env planning-poker-api

  


### Contributions

1. Fork it

2. git checkout -b 

3. git add --all && git commit -m "feature description"

4. git push origin 

5. Create a pull request

[logo]: https://raw.githubusercontent.com/planning-poker/planning-poker-api/master/logo.png "Planning Poker (api) - Logo"