Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Keep track of who's in the office
JavaScript CSS
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
client
config
controllers
lib
migrations
models
public
test
views
.bowerrc
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
Makefile
Readme.md
app.js
bower.json
package.json

Readme.md

Stalker-O-Matic Build Status

Installation

Dependencies can be installed using npm (npm install). Client dependencies will need to be installed using bower, install bower globally using npm install -g bower and run bower install.

Building

This project uses grunt, and both development and projection clients can be built with grunt development and grunt production respectably.

Environment variables

STALKER_PORT

default: 3000

Signifies which port the Stalker server should run on

API_TOKEN

default: please

Token that should be used when authenticating against the api in the case that a session or user auth token is not used.

SESSION_SECRET

default: dirty secret

Salt for hashing session cookies. Should just be a random crypto value.

CONSUMER_KEY

OAuth2 provider consumer key, you will need this, or you're gonna have a bad time.

CONSUMER_SECRET

OAuth2 provider secret, you will also need this, or you're gonna have a doubly bad time.

Running

Currently Stalker uses the TxSSC/SSO project, which is internal only. It uses passport, so this could easily be substitued for another OAuth2 provider.

To run you will need to get set the appropriate environment variables and run npm start or node app.

Testing

Stalker tests can be run with npm test or make test.

API

(To be continued...)

License (MIT)

Copyright (c) 2014 TXSSC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.