<commit_before># Social Framework ![License MIT](https://go-shields.herokuapp.com/license-MIT-blue.png)

----
[![Build Status](https://travis-ci.org/TCC-SocialNetwork/social_framework.svg)](https://travis-ci.org/TCC-SocialNetwork/social_framework)	[![Code Climate](https://codeclimate.com/github/TCC-SocialNetwork/social_framework/badges/gpa.svg)](https://codeclimate.com/github/TCC-SocialNetwork/social_framework)	[![Test Coverage](https://codeclimate.com/github/TCC-SocialNetwork/social_framework/badges/coverage.svg)](https://codeclimate.com/github/TCC-SocialNetwork/social_framework/coverage)	[![Inline docs](http://inch-ci.org/github/TCC-SocialNetwork/social_framework.svg)](http://inch-ci.org/github/TCC-SocialNetwork/social_framework)	[![Stories in Ready](https://badge.waffle.io/TCC-SocialNetwork/social_framework.png?label=ready&title=Ready)](http://waffle.io/TCC-SocialNetwork/social_framework)	[![Stories in Progress](https://badge.waffle.io/TCC-SocialNetwork/social_framework.png?label=in%20progress&title=In%20Progress)](http://waffle.io/TCC-SocialNetwork/social_framework)

----
# What is SocialFramework?

> The SocialFramework is a Rails Engine that helps developers build Social Networks providing common and specific resources to this.

> SocialFramework is divided in three modules, which are: Users, Routes and Schedulers.
In Users module the principal resources to users are providing, like authentication, register, relationships and searchs.
In Routes the Framework provides resources to define routes to users in different situations and provides ways to work this.
And in Schedulers, provides resources to define schedules to users and attempts to relate this schedules.

> Therefore, the SocialFramework can help build Social Networks general or specifics in a way faster and practical and without not worry with recurring problems in this type of system.

----
# Author

* Jefferson <NAME>
 * <EMAIL>
* <NAME><commit_msg>adding installation to readme<commit_after># Social Framework ![License MIT](https://go-shields.herokuapp.com/license-MIT-blue.png)

----
[![Build Status](https://travis-ci.org/TCC-SocialNetwork/social_framework.svg)](https://travis-ci.org/TCC-SocialNetwork/social_framework)
[![Code Climate](https://codeclimate.com/github/TCC-SocialNetwork/social_framework/badges/gpa.svg)](https://codeclimate.com/github/TCC-SocialNetwork/social_framework)
[![Test Coverage](https://codeclimate.com/github/TCC-SocialNetwork/social_framework/badges/coverage.svg)](https://codeclimate.com/github/TCC-SocialNetwork/social_framework/coverage)
[![Inline docs](http://inch-ci.org/github/TCC-SocialNetwork/social_framework.svg)](http://inch-ci.org/github/TCC-SocialNetwork/social_framework)
[![Stories in Ready](https://badge.waffle.io/TCC-SocialNetwork/social_framework.png?label=ready&title=Ready)](http://waffle.io/TCC-SocialNetwork/social_framework)
[![Stories in Progress](https://badge.waffle.io/TCC-SocialNetwork/social_framework.png?label=in%20progress&title=In%20Progress)](http://waffle.io/TCC-SocialNetwork/social_framework)

----
# What is SocialFramework?

> The SocialFramework is a Rails Engine that helps developers build Social Networks providing common and specific resources to this.

> SocialFramework is divided in three modules, which are: Users, Routes and Schedulers.
In Users module the principal resources to users are providing, like authentication, register, relationships and searchs.
In Routes the Framework provides resources to define routes to users in different situations and provides ways to work this.
And in Schedulers, provides resources to define schedules to users and attempts to relate this schedules.

> Therefore, the SocialFramework can help build Social Networks general or specifics in a way faster and practical and without not worry with recurring problems in this type of system.

----
# Install

> Currently the SocialFramework is not present in RubyGems. To use it you need to clone this repository, below the steps required for installation are presented.

> Clone this repository:

```console
git clone https://github.com/TCC-SocialNetwork/social_framework.git
```

> Adding the following line in your Gemfile:

```ruby
gem 'social_framework', path: 'path/to/social_framework'
```

> The path is the locale of clone done.
After adding gem in your Gemfile intall it:

```console
bundle install
```

> This will be add the SocialFramework to your app.

----
# Author

* <NAME>
 * <EMAIL>
* <NAME>
{'fraction_non_alphanumeric': 0.11483467381590706, 'fraction_numerical': 0.0017873100983020554, 'mean_word_length': 5.682089552238806, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 20, 'https://': 19, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1232269', 'n_tokens_mistral': 1331, 'n_tokens_neox': 1259, 'n_words': 352}