abeyko/countly-server

Countly Mobile Analytics & Push Notifications Server (Community Edition)

#Countly

We're hiring: Countly is looking for full stack node.js & JS developers to work on its core platform. Click this link for job description

##What's Countly? Countly is an innovative, real-time, open source mobile analytics application. It collects data from mobile phones, tablets and other internet-connected devices, and visualizes this information to analyze mobile application usage and end-user behavior. There are two parts of Countly: the server that collects and analyzes data, and mobile SDK that sends this data.

This repository holds Countly Community Edition. For more information other versions (e.g Enterprise Edition), see Editions page

##Supported devices

Countly supports top-notch devices, including iOS, Android, Windows Phone and Blackberry. You can find a list of officially and community supported Countly SDK libraries here. Each SDK has its own installation instructions.

##Installing & upgrading Countly server

You can either download all files from Sourceforge, or get code from Github (this page). We provide a beautiful installation sript (bin/countly.install.sh) with countly-server package that installs and configures everything required to run Countly Server.

If you feel like doing things manually, or need to upgrade Countly from a previous version, please take a look at the installation & upgrading articles at http://resources.count.ly.

Countly also has Docker support - see our official Docker repository

##Installing Countly server with Push Notifications support

Countly includes push notifications support for iOS and Android. In order to checkout this code, use "messaging" branch. This will download all Countly Analytics code plus code required to run Countly server with push notifications support.

git clone -b messaging https://github.com/Countly/countly-server.git

In order to download Countly SDK for push notification support, you also need to checkout messaging branches of Android SDK and iOS SDK. Refer to instructions on each SDK page for more information on how to setup SDKs.

##Dependencies We develop and test Countly on Ubuntu with MongoDB, Node.js and nginx. Installation script only needs a clean, decent Ubuntu Linux without any services listening to port 80 and takes care of every library and software (e.g MongoDB, Nginx, Node.js, Expressjs etc) required to be installed on Ubuntu Linux.

Countly Community also provides scripts to install Countly on Mac OS X or Debian Wheezy

##API & Frontend

API documentation can be found here.

Other important files are frontend/express/app.js (Countly dashboard that runs on Express server), frontend/express/public/javascripts/countly (Contains seperate helper js files for each data visualization), countly.session.js (responsible for calculating session related metrics) and api/api.js, which is Countly write and read API. Waits for write requests from the mobile SDKs and read requests from the Countly js helpers.

##How can I help you with your efforts? See our section on how to contribute to Countly

##Links

• Countly web page
• Countly support
• Documentation & user guide
• Countly API reference guide
• Countly Enterprise & Cloud Edition
• Packages on Sourceforge for direct download