A lightweight, open source analyitcs application
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client
config
node_modules
server
test
.bowerrc
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE
README.md
bower.json
package.json
server.js

README.md

Observer

A lightweight, open source analyitcs application.

A simpler answer for analytics on the web

I'm creating this application because I was tired of using an analytics pacakge that did not share my goals. I wanted a simple solution that allowed me to gather traffic data from my websites and improve them, while respecting my users.

Design goals

The design goals for Observer are simple:

  • Respect site visitors 'Do Not Track' preferences
  • Gather accurate traffic data
  • Offer a simple drop-in script for website administrators
  • Provide RESTful API for traffic data
  • Provide a simple user interface

Work in progress

This application is brand new, and is not usable. I will create an alpha release soon. Until that time, anyone who wants to use the application is free to, but please understand that not all of the design goals may not be met.

Development information

Code Climate Build Status

Installation

To setup the application, clone this repository into a local directory, and run npm install.

Set your environment (dev, test, production, etc.) with NODE_ENV. If you do not, it will run in the default environment, which is development. All tests that interact with MongoDB are set to test by default. If you wish change this setting, it can be found in test/db.js

Build, test and run

Observer uses Grunt and to build and run the application. Running grunt executes the default build, which launches both nodemon, which watches for changes. Any changes to the watched source code files will trigger a new build and reload the server.

To execute tests in watch mode, run grunt test. To execute a single run of the test suite, use grunt test:once.

Current issues, caveats, etc.

IP harvesting does not work unless your environment is configured to use the X-Real-IP header. If you are running nginx, you need to pass this through to your node app. I'm working on getting it working in the development environment, but I'm not there yet.

License

Observer is released under the MIT License (MIT)

Copyright (c) 2014 Brian Lundin

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.

All other open source components are used according to their own licensing terms.