Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixelpark/ppnet
This service can be used to create a social network, either temporarily or permanently for a group of users
https://github.com/pixelpark/ppnet
Last synced: about 1 month ago
JSON representation
This service can be used to create a social network, either temporarily or permanently for a group of users
- Host: GitHub
- URL: https://github.com/pixelpark/ppnet
- Owner: pixelpark
- License: mit
- Archived: true
- Created: 2014-01-08T10:12:48.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-03-03T08:13:00.000Z (almost 7 years ago)
- Last Synced: 2024-08-01T12:35:54.593Z (4 months ago)
- Language: JavaScript
- Homepage: http://wiki.mediafi.org/doku.php/ficontent.common.enabler.socialnetwork
- Size: 15.7 MB
- Stars: 118
- Watchers: 27
- Forks: 19
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - pixelpark/ppnet - This service can be used to create a social network, either temporarily or permanently for a group of users (others)
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](http://mediafi.org/?portfolio=social-network).
# Version 2.0
PPnet is built as a single page application (SPA) in the JavaScript framework AngularJS, and uses a [PouchDB](https://github.com/pouchdb/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)](https://github.com/ging/fi-ware-idm).
# 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](https://www.docker.com/), you are just one step away from your PPnet running - [you will find it in this README](https://github.com/pixelpark/ppnet/blob/master/server/DOCKER.MD).
It should be noted that we built the Docker environment in collaboration with the friendly people from [Giant Swarm](https://giantswarm.io/). 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](https://github.com/pixelpark/ppnet/archive/master.zip),
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 `remote`entry in the [config file](https://github.com/pixelpark/ppnet/blob/master/www/config.json#L6) 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](https://www.youtube.com/watch?v=DYPGQlC5SVA&feature=youtu.be) which will updated soon.
# Build
You can find more build instructions [here](https://github.com/pixelpark/ppnet/blob/master/BUILD.md).
## FAQ
The FAQ is [here](https://github.com/pixelpark/ppnet/blob/master/FAQ.md).
# Team
- Tobias Rotter ([@tobiasrotter](https://github.com/tobiasrotter))
- Philipp Reinking ([@PhilReinking](https://github.com/PhilReinking))
- Dirk Krause ([@dirkk0](https://github.com/dirkk0))
- Daniel Pritzkau ([@teawithfruit](https://github.com/teawithfruit))
- Markus Neuy ([@markusneuy](https://github.com/markusneuy))