/nucleus-vagrant

A vagrant file to work on Nucleus

Primary LanguageShellMIT LicenseMIT

Nucleus Vagrant

Software License

Background

Vagrant and Virtualbox is an easy way to develop on projects cross-platform without having to worry about environment configuration and setup.

This vagrant file setups up an Ubuntu virtual machine and configures it to run Nucleus.

Usage

To use the vagrant file, you will need to have done the following:

  1. Download and Install VirtualBox
  2. Download and Install Vagrant
  3. Open a shell prompt (Terminal app on a Mac) and cd into the folder containing the Vagrantfile
  4. Run vagrant up

The first time you run vagrant up, Vagrant will download the required virtual box image, and then download and install all required packages. Once that is done, it will setup SQL and Nginx as necessary, and then download and setup Nucleus.

Once the VM is running, you can edit nucleus inside of the new nucleus folder in the folder containing the Vagrantfile on the host machine. if any configurations to the VM environment are necessary, you can access it by running vagrant ssh. Inside of the VM, the nucleus project directory is located at /vagrant/nucleus.

To access the running serice, simply navigate your browser on the host machine to http://localhost:8931. This port can be configured in the Vagrantfile.