Ruby JavaScript HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.librarian/chef
app
bin
config
db
docs
frontend
lib
log
public
script
spec
.env.example
.env.travis
.gitignore
.rspec
.rubocop.yml
.travis.yml
CHANGELOG.md
Capfile
Cheffile
Cheffile.lock
Gemfile
Gemfile.lock
LICENSE.md
README.md
Rakefile
Vagrantfile
Vagrantfile.chef
config.ru
node.json

README.md

ALM Reports

Build Status Code Climate Test Coverage

How to start developing now?

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):

  1. Install Vagrant: https://www.vagrantup.com/downloads.html
  2. Install Virtualbox: https://www.virtualbox.org/wiki/Downloads
  3. Clone this repository git clone git@github.com:articlemetrics/alm-report.git
  4. 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:

ALM Reports screenshot

Developing using AWS/EC2

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

Documentation

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.

License

ALM Reports is released under the MIT License.