https://github.com/helium/mappers
Mappers Frontend and API
https://github.com/helium/mappers
Last synced: about 1 year ago
JSON representation
Mappers Frontend and API
- Host: GitHub
- URL: https://github.com/helium/mappers
- Owner: helium
- License: apache-2.0
- Created: 2021-01-15T06:19:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T22:05:17.000Z (over 1 year ago)
- Last Synced: 2025-03-30T12:08:50.866Z (about 1 year ago)
- Language: Elixir
- Homepage:
- Size: 679 KB
- Stars: 70
- Watchers: 30
- Forks: 27
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - helium/mappers - Mappers Frontend and API (Elixir)
README
# Mappers
## Development and Contribution
Any and all contributions from the community are encouraged.
- Guidelines for how to contribute to this repository [are here](https://github.com/helium/mappers/blob/master/CONTRIBUTING.md).
- Discussion about the development and usage of the Helium Mappers takes place in the [official Helium Discord Server](https://discord.gg/helium), specifically in the `#mappers` channel. Join us!
- For a list of issues and prioritization, please go to our [Project page](https://github.com/orgs/helium/projects/14).
## Getting Started:
### 1. First, clone the repository to your local machine and navigate into the folder. For example:
```bash
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`](http://localhost:4000) from your browser.
To Reset Database
* Run `mix ecto.reset`