Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 2.72 KB

DEVELOPER.md

File metadata and controls

97 lines (68 loc) · 2.72 KB
Raw

Building and Testing

This document describes how to set up your development environment to build and test eximap. It also explains the basic mechanics of using git, elixir, and hex.

See the contribution guidelines if you'd like to contribute to eximap.

Prerequisite Software

Before you can build and test eximap, you must install and configure the following products on your development machine:

Getting the Sources

Fork and clone the eximap repository:

  1. Login to your GitHub account or create one by following the instructions given here.
  2. Fork the main eximap repository.
  3. Clone your fork of the eximap repository and define an upstream remote pointing back to the eximap repository that you forked in the first place.
# Clone your GitHub repository:
git clone git@github.com:<github username>/eximap.git

# Go to the eximap directory:
cd eximap

# Add the main eximap repository as an upstream remote to your repository:
git remote add upstream https://github.com/around25/eximap.git

Installing HEX packages

Next, install the JavaScript modules needed to build and test geeximap:

# Install eximap project dependencies (mix.exs)
mix local.hex --force
mix local.rebar --force
mix deps.get
mix deps.compile
mix compile

Building

To build eximap for release run:

mix deps.get --only prod
mix deps.compile
mix release --warnings-as-errors --env=prod
  • Results are put in the lib folder.

Building Documentation Locally

To generate the documentation:

# Generate all eximap documentation
$ mix docs

Running Tests Locally

To run tests:

# Run all eximap tests
$ mix credo
$ mix coveralls

You should execute the test suites before submitting a PR to github.

All the tests are executed on our Continuous Integration infrastructure and a PR could only be merged once the tests pass.

  • Travis CI fails if any of the test suites described above fails.