Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 2.48 KB

README.md

File metadata and controls

74 lines (44 loc) · 2.48 KB
Raw

#𝜋seis

𝜋Seis: People Says, what people around the world is saying about something... you've got it.

##Status GitHub version Semver Build Status Codacy Badge

##Issues

Stories ready to be worked on ![Stories in progress](https://badge.waffle.io/barriosnahuel/piseis.png?label=in progress&title=In Progress)

Throughput Graph

##Repo usage Do not clone or push to master branch.

Create branch or fork from develop, then push or create pull requests (if you don't have access) to that branch.

The repo uses this branching model.

##Server

###Start

npm start

###Run checks

####Tests

grunt nodeunit

####JSHint

grunt jshint

###PRO tips!

  • To run all checks at once simply run:

    npm test

##jQuery plugin

// TODO

##Demo project There is a demo where you can see both the jQuery plugin and the server in action.

  1. Run the server

    cd server/
npm start

  2. Open /demo/index.html in your favourite browser.

  3. Run some queries!

##License

PiSeis - What people around the world is saying, you've got it.
 Copyright (C) 2013 Nahuel Barrios <[email protected]>.

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.