graphjs/server

GraphJS REST APIs

0.9.0 2019-08-20 09:20 UTC

Requires

• php: ^7.2.0
• ext-bcmath: *
• ext-gd: *
• ext-mbstring: *
• ext-sodium: *
• aws/aws-sdk-php: ^3.87
• danielstjules/stringy: ^3.1
• get-stream/stream: ~2.7
• mailgun/mailgun-php: ^2.5.0
• pho-adapters/index-neo4j: dev-master
• pho-adapters/index-redis: dev-master
• pho-adapters/storage-aws-s3: dev-master
• pho-recipes/network: dev-private-content
• pho-recipes/web: dev-private-content
• phonetworks/pho-kernel: dev-master
• phonetworks/pho-plugins-feeds: ^0.1
• phonetworks/pho-server-rest: ^2.1.3
• php-ffmpeg/php-ffmpeg: ^0.13.0
• php-http/guzzle6-adapter: ^1.0
• rakit/validation: ^0.22.2
• ramsey/uuid: ^3.0
• riverline/multipart-parser: ^2.0
• superbalist/php-pubsub-redis: ^2.0
• vanilla/garden-cli: ~2.0
• vlucas/phpdotenv: ^2.4

Requires (Dev)

• psy/psysh: *
• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^2.5

AGPL-3.0-or-later

• Emre Sokullu

README

An event-driven, non-blocking GraphJS Server.

Extends Pho REST Server APIs. For more information, check out http://graphjs.com

GraphJS-Server does not rely on a third party HTTP Server such as NGINX or Apache HTTPD. But it is recommended that you run it behind a proxy server for static assets and caching.

Requirements

• PHP 7.2+
• PHP extensions: bcmath, sodium, gd, mbstring, simplexml
• Composer
• Git
• Redis: Install
• Neo4j: Install
• ffmpeg

Heroku Installation

Heroku is popular cloud provider by Salesforce. To install, just click the button below, and when asked, fill in the form with your email (you don't need to touch any other fields):

WARNING for Heroku installations: Since GrapheneDB (the cloud Neo4J provider) provision takes longer than app's initial build and launch, you will need to wait at least 5 minutes before testing your instance after setup. If it still doesn't work, try rebooting the app after it's built for the first time. This is a common issue first-time Heroku installers are facing, please beware.

Once Heroku is deployed you can test it with the /whoami command with a GET request to https://{my_heroku_instance}.herokuapp.com/whoami

Feel free to watch this video at https://youtu.be/K7bWKlT0k_g for a preview of the process.

Manual Installation

In case, heroku installation is not an option for you, here are the steps to install it manually:

1. The recommended way to install pho-server-rest is through git. MacOS and most UNIX operating system come with git equipped.

   git clone https://github.com/phonetworks/graphjs-server/

   If you are on Windows or don't have git preinstalled, you may download and install git from https://git-scm.com/, or just download the graphjs-server zip tarball from https://github.com/phonetworks/graphjs-server/archive/master.zip and extract.

2. Install the PHP dependencies using Composer.

   composer install
   

3. Create a copy .env.example file as .env file.

4. Update the .env file.

   1. Set the Neo4j username and password of INDEX_URI. For example:

      bolt://neo4j_username:neo4j_password@localhost:7687
      

   2. Set values of FOUNDER_NICKNAME, FOUNDER_EMAIL, FOUNDER_PASSWORD.

   3. Set values of MAILGUN_KEY, MAILGUN_DOMAIN. (Optional)

License

MIT, see LICENSE.