A ready to go streaming server.

Version: 0.0.0

Web: Coming later, neap.io

Project Owner: Michaël "e7d" Ferrand

In order to run the code of Neap effectively, you'll need to have a few tools installed:

1. Install Git
2. Install VirtualBox
3. Install Vagrant

1. Add the Git executables to your path
2. Install Vagrant::WinNFSd, to use NFS on a Windows host
   vagrant plugin install vagrant-winnfsd

1. Use a development workstation with at least 2 cores and 8GB of RAM, as Vagrant should be allocated 1GB of RAM
2. Install Vagrant::Hostsupdater, to keep your hosts file in line with the built VM
   vagrant plugin install vagrant-hostsupdater
3. Install Vagrant::VBGuest, to manage the host's VirtualBox Guest Additions on the guest system
   vagrant plugin install vagrant-vbguest

1. git clone https://github.com/e7d/neap.git to clone the latest version
2. Change into the directory neap
3. Run vagrant up

For an "In-Place" upgrade of a working environment:

1. git pull to get the latest version of the code
2. Change into the directory neap
3. Run vagrant reload
4. Run vagrant provision

For a complete update from scratch, destroying and rebuilding everything:

1. git pull to get the latest version of the code
2. Change into the directory neap
3. Run vagrant destroy
4. Run vagrant up

Neap is using its own "virtual box" to manage its environment, embedding the whole needed software. You can consult a detailed list here: Neap Box software stack

On top of that, Neap adds:

• Zend Framework 2 as PHP framework, with:
  • Apigility as API framework
  • React as I/O library
  • Ratchet as WebSocket library
• Angular 2 as JavaScript framework, with:
  • Polymer as Web Components library
  • React as use interfaces library
  • lodash as utility library
• Emoji One as Emoji collection
• twemoji as alternative Emoji collection

Once the VM is done provisioning, direct your browser to https://neap.dev You will receive fuller instructions on the use of this Vagrant environment there.

These URLs also provide you some control over the project:

• neap.dev -- General documentation and links for all of the tools
• api.neap.dev -- API interface
• doc.neap.dev -- API documentation interface
• db.neap.dev -- Database administration interface
• irc.neap.dev -- IRC server
• static.neap.dev -- Cache content access
• Soon: swagger.neap.dev -- Swagger documentation interface
• Soon: cache.neap.dev -- Cache performance test

Neap utilizes Vagrant's synced folders to create a shared folder, that is accessible from both the Neap virtual machine and your operating system.
This directory will be available for use after the first time the virtual machine is started using the vagrant up command. You can access it directly by going to the neap sources directory in the Finder or Explorer of your operating system.

To connect to the Vagrant instance, type vagrant ssh from a console located in the Neap directory.

A database representation made with pgModeler (PostgreSQL Database Modeler) may be found under the resources\database\neap.dbm location, alongside a PNG view of this same model.
The PostgreSQL instance may be administrated through pgAdmin, with this connection information:

• Host: localhost
• Port: 5432
• Username: neap
• Password: neap

README.md - This markdown file, the technical steps to get Neap up and running.
Wiki - Coming later: Frequently asked questions, per OS install guides, debugging information