ALM Reports uses Vagrant and Virtualbox for setting up the development environment. To start developing now on your local machine (Mac OS X, Linux or Windows):
- Install Vagrant: https://www.vagrantup.com/downloads.html
- Install Virtualbox: https://www.virtualbox.org/wiki/Downloads
- Clone this repository
git clone git@github.com:articlemetrics/alm-report.git - Cd into it and run
vagrant up
Once the setup is complete (it might take up to 20 minutes), you'll be able to open up a browser and navigate to http://10.2.2.2, and you should see this screen:
You can also use a VM from AWS/EC2 to develop on, by first setting the relevant AWS credentials in Vagrantfile:
aws.access_key_id = "EXAMPLE"
aws.secret_access_key = "EXAMPLE"
aws.keypair_name = "EXAMPLE"
aws.security_groups = ["EXAMPLE"]
override.ssh.private_key_path = "~/path/to/ec2/key.pem"
And then specifying the awsprovider:
vagrant up --provider=aws
Detailed instructions on how to start developing are here.
When you're ready to deploy ALM Reports, take a look at the in-depth deployment guide.
In case you would like to setup the dependencies manually (for example for non-Vagrant local development, or for servers not provisioned with Chef), check out the manual installation guide.
ALM Reports is released under the MIT License.