<commit_before># ![favicon](http://githubsocial.com/favicon_github.png) GithubSocial [![Dependency Status][gemnasium-img-url]][gemnasium-url] [![Code Climate][codeclimate-img-url]][codeclimate-url] [![Build Status][travis-img-url]][travis-url]

[codeclimate-img-url]: https://codeclimate.com/github/sheerun/githubsocial/badges/gpa.svg
[codeclimate-url]: https://codeclimate.com/github/sheerun/githubsocial
[gemnasium-img-url]: https://gemnasium.com/sheerun/githubsocial.png
[gemnasium-url]: https://gemnasium.com/sheerun/githubsocial
[travis-img-url]: https://travis-ci.org/sheerun/githubsocial.svg
[travis-url]: https://travis-ci-org/sheerun/githubsocial

Collaborative repository recommendations based on GitHub stars.

## Requirements

- Ruby 2.1.0
- PostgreSQL 9.x
- Redis 3.0.0, preferably 32bit

## Technologies

- Ruby & Rails 4
- CoffeeScript & Angular 1.2
- [Rails Assets](https://rails-assets.org/)
- SCSS, SLIM
- Sidekiq

## Installation

Application requires Redis and PostgreSQL database dumps. They can be downloaded using `bin/download` script. Please download only if you really need to test live data.

```bash<commit_msg>Add "What" section of the README<commit_after># ![favicon](http://githubsocial.com/favicon_github.png) GithubSocial [![Dependency Status][gemnasium-img-url]][gemnasium-url] [![Code Climate][codeclimate-img-url]][codeclimate-url] [![Build Status][travis-img-url]][travis-url]

[codeclimate-img-url]: https://codeclimate.com/github/sheerun/githubsocial/badges/gpa.svg
[codeclimate-url]: https://codeclimate.com/github/sheerun/githubsocial
[gemnasium-img-url]: https://gemnasium.com/sheerun/githubsocial.png
[gemnasium-url]: https://gemnasium.com/sheerun/githubsocial
[travis-img-url]: https://travis-ci.org/sheerun/githubsocial.svg
[travis-url]: https://travis-ci-org/sheerun/githubsocial

Real-time collaborative repository recommendations based on GitHub stars.

## What?

Application is using information about starred repositories on GitHub, to produce clever and quick recommendation of what to like next. It recognizes collective trends by analysing hundreds of thousands of stars per recommendation.

Application is using offline data updated in real-time from [GitHub API](https://developer.github.com/v3/). Seed data has been extracted from [Github Archive](http://www.githubarchive.org/), and [GH Torrent](http://ghtorrent.org/) websites. Specifically:

- List of GitHub Repositories (stored in Postgres)
- List of GitHub Users (stored in Postgres)
- List of starred Repositories of each User (stored in Redis)

## Requirements

- Ruby 2.1.0
- PostgreSQL 9.x
- Redis 3.0.0, preferably 32bit

## Technologies

- Ruby & Rails 4
- CoffeeScript & Angular 1.2
- [Rails Assets](https://rails-assets.org/)
- SCSS, SLIM
- Sidekiq

## Installation

Application requires Redis and PostgreSQL database dumps. They can be downloaded using `bin/download` script. Please download only if you really need to test live data.

```bash
{'fraction_non_alphanumeric': 0.1305668016194332, 'fraction_numerical': 0.008434547908232119, 'mean_word_length': 5.08829568788501, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 15, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7669708', 'n_tokens_mistral': 1000, 'n_tokens_neox': 964, 'n_words': 239}