Mappers
Development and Contribution
Any and all contributions from the community are encouraged.
- Guidelines for how to contribute to this repository are here.
- Discussion about the development and usage of the Helium Mappers takes place in the official Helium Discord Server, specifically in the
#mappers channel. Join us!
- For a list of issues and prioritization, please go to our Project page.
Getting Started:
1. First, clone the repository to your local machine and navigate into the folder. For example:
git clone https://github.com/helium/mappers.git
cd mappers
2. Second, install all the dependencies:
System dependencies:
- cmake
- postgres - add user/password postgres/postgres
- postgis
Application Dependencies:
- Install dependencies with
mix deps.get
- Create and migrate your database with
mix ecto.setup
3. Edit your environment variables:
- Open the .sample.env file located at the root of the project
- Create a Mapbox account and copy your public access token
- Paste it in place of for the PUBLIC_MAPBOX_KEY variable. That line should now look like this:
PUBLIC_MAPBOX_KEY=pk.ey[...the rest of your access token...]
Rename the file ".env" (delete ".sample" from the file name)
4. Install Node.js dependencies with cd assets && yarn
5. Start development server:
- Start Phoenix endpoint with
mix phx.server
Now you can visit localhost:4000 from your browser.
To Reset Database