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.
- Prerequisite Software
- Getting the Sources
- Installing HEX Modules
- Building
- Building Documentation Locally
- Running Tests Locally
See the contribution guidelines if you'd like to contribute to eximap.
Before you can build and test eximap, you must install and configure the following products on your development machine:
-
Git and/or the GitHub app (for Mac or Windows); GitHub's Guide to Installing Git is a good source of information.
-
Elixir which is used to run the code and tests, and generate distributable files.
Fork and clone the eximap repository:
- Login to your GitHub account or create one by following the instructions given here.
- Fork the main eximap repository.
- Clone your fork of the eximap repository and define an
upstreamremote pointing back to the eximap repository that you forked in the first place.
# Clone your GitHub repository:
git clone [email protected]:<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.gitNext, 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 compileTo 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.
To generate the documentation:
# Generate all eximap documentation
$ mix docsTo run tests:
# Run all eximap tests
$ mix credo
$ mix coverallsYou 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.