KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

socializer

★ 58 Open GitHub ↗

Rails engine to make your projects social. Adds stream, profile, circles, groups and notifications.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Socializer [![Gem Version](https://badge.fury.io/rb/socializer.svg)](https://badge.fury.io/rb/socializer) [![Status](https://img.shields.io/badge/Alpha-Not_Production_Ready-d84a38.svg?style=flat)](https://raw.githubusercontent.com/socializer/socializer/main/)

[![CI](https://github.com/socializer/socializer/actions/workflows/ci.yml/badge.svg)](https://github.com/socializer/socializer/actions?query=workflow%3ACI)
[![Coverage Status](https://coveralls.io/repos/github/socializer/socializer/badge.svg?branch=main)](https://coveralls.io/github/socializer/socializer?branch=main)
[![Maintainability](https://api.codeclimate.com/v1/badges/597d0f0dd08d9ec1dba5/maintainability)](https://codeclimate.com/github/socializer/socializer/maintainability)
[![Dependency Status](https://gemnasium.com/badges/github.com/socializer/socializer.svg)](https://gemnasium.com/github.com/socializer/socializer)
[![Inline docs](https://inch-ci.org/github/socializer/socializer.svg?branch=main)](https://inch-ci.org/github/socializer/socializer)

Socializer is a rails engine fully dedicated to adding social network capabilities so you can focus
on what really matters.

It is designed based on the Wikipedia definition of [social networks](https://en.wikipedia.org/wiki/Social_network)
and the excellent spec from [activitystrea.ms](https://www.activitystrea.ms). Yes, it may look like a Google+ clone, but Google did a
great job implementing the social network definition. And yes, it does a lot less than Google+, we don't have
400 developers on the project.

## Important notice

Socializer is **not ready for production** yet. It's a work in progress. If you would like to get involved, fork and work! Or contact me at dominic.goulet@icloud.com.

## Core concepts

**People** are connected with each other in numerous ways. First of all, they can signify to another person
that they want to be connected with them by adding them to their **circles**. The association between a person
and a circle is called a **tie**. This link is not direct and does not force each person to have the same link.
For instance, one person can classify the other as a 'friend', while the other person will return the favor by adding
them to their 'colleague' circle. Second, **groups** are a link between people where all members share the same level
of connection with each other. They are all members of the 'Project X Research Group'. The association between a
person and a group is called **membership**.

Like any other social networking application, you can post **notes**. Notes are pieces of information (currently only
text is supported, but pictures, videos, files and more are coming) that you want to keep for posterity.

When you perform actions in Socializer, there is a log of your **activities**. Activities are shared with
an **audience**. Let's say you perform the action of creating a note. While creating a note,
you will have to specify the audience for that note. You can choose between 'Public', 'All your circles', any of your
circles, any of your groups, and any of the people you are connected with.

People can view the activity **stream** with different filters :
* **Profile** - you see all the activities of a single person
* **Circle** - you see the activities performed by the people in that circle
* **Group** - you see the activities performed by the people in that group
* **Home** - you see everything from the people you connect with (groups, circles, yourself)

When viewing a stream, people can **comment** on any of the objects in the stream.

For registration and login, Socializer is currently using omniauth with the following providers:
LinkedIn, Facebook, Twitter, Yahoo, Google and Identity. Once your account is created, you can bind multiple
authentications to your account. This will be used later on to share your activities with other networking sites.

## Installation

Add this line to your application's Gemfile:

gem 'socializer', github: 'socializer/socializer'

And then execute:

$ bundle

Then:

bin/rails socializer:install:migrations

Don't forget to migrate your database:

bin/rails db:migrate

## Getting Started

## Todo

The todo list is as follows :
* Finish core components (people, circles, groups, notes, comments)
* Complete the activity stream (activities, audience)
* Add notifications (notify a person when an activity affects them directly)
* Add interaction with other networking sites (authentications)
* Add a search feature (to find people, groups and notes)
* Create a comprehensive html structure that can easily be templated in host applications
* Package the engine cleanly (configurations, file names, etc.)

## If you want to contribute

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/socializer/socializer/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

The best way to contribute is to do one of the following :
* Creating tests
* Refactoring
* Coding features
* Correcting logged issues
* Correcting my English! (I'm a french Canadian, so don't hesitate to fix my sentences or whole paragraphs.)

## License ##

Socializer is available as open source under the terms of the [MIT License]
(https://opensource.org/licenses/MIT).

socializer

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README