PPnet

Create and host your own social network.

Code Quality Rank: L4

Programming language: JavaScript

Tags: Communication systems     Social Networks and Forums    

Latest version: v2.3.1

README

PPnet

March, 2018: This project is not maintained any more!

What is this?

"We need something like Facebook, but just not Facebook." If you heard that from your client, or thought that yourself, PPnet might be for you.

Create and host your own social network. With some simple steps you can get it in less then 15 minutes. This project is partly funded by the Europian Union through the FI-CONTENT.

Version 2.0

PPnet is built as a single page application (SPA) in the JavaScript framework AngularJS, and uses a PouchDB/CouchDB combination for data synchronisation. The nice thing about this architecture is that you only need a CouchDB as a server side component (plus a simple HTTP Server) and that it works in online/offline mode. Additionally, it can authenticate against OAuth2 comaptible providers (like KeyRock).

Installation

tl;dr

Build the project

gem install compass
git clone https://github.com/pixelpark/ppnet
cd ppnet
npm install -g gulp bower
npm install
bower install
gulp

Build the Phonegap/Cordova App

The project must be build.

gulp build

cordova platform add android
cordova platform add ios

phonegap plugin add org.apache.cordova.device-orientation
phonegap plugin add org.apache.cordova.file
phonegap plugin add org.apache.cordova.file-transfer
phonegap plugin add org.apache.cordova.device
phonegap plugin add org.apache.cordova.camera
phonegap plugin add org.apache.cordova.statusbar
phonegap plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
phonegap plugin add https://github.com/apache/cordova-plugin-whitelist.git

phonegap build android
phonegap run android

Docker

To get ppnet running in three simple steps with docker, you have to do this.

git clone https://github.com/pixelpark/ppnet .
docker build -t pixelpark/ppnet .
docker run -d -p 8000:80 pixelpark/ppnet

Giant Swarm

If you are familiar with Docker, you are just one step away from your PPnet running - you will find it in this README.

It should be noted that we built the Docker environment in collaboration with the friendly people from Giant Swarm. Their startup is based on the idea of handling Docker containers in a simple way.

Steps for a simple quickstart

If you don't want to go through the hassle of installing development tools you can test PPnet by following these steps:

1. simply download the zip file of this repository,
2. navigate to the www directory (cd www)
3. start a web server right there (python -m SimpleHTTPServer or python3 -m http.server)
4. Navigate to http://localhost:8000

You should see PPnet with that latest entries of our test database.

To connect to your own database, you only need to change the remoteentry in the config file to a running, CORS enabled CouchDB. Changing this is the minimum thing you want to do to create your own database for your own social network. You will want to change the other entries too, to change the name of the application, the default location and so forth.

Server / Proxy

If you want to run PPnet behind a Proxy, especially the connection to the CouchDB, you should use server.js. You find the file and a readme in the folder "server".

Video

There is a somewhat outdated video of PPnet in action which will updated soon.

Build

You can find more build instructions here.

FAQ

The FAQ is here.

Team

• Tobias Rotter (@tobiasrotter)
• Philipp Reinking (@PhilReinking)
• Dirk Krause (@dirkk0)
• Daniel Pritzkau (@teawithfruit)
• Markus Neuy (@markusneuy)