-
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,19 +19,30 @@ For a mobile application that is compatible with Mapeo Desktop, see [Mapeo Mobil | |
|
||
Read the [online user guide](https://digital-democracy.gitbook.io/mapeo/) for | ||
information on how to install aerial imagery and tiles, custom configurations, | ||
and more. | ||
and more. | ||
|
||
![architecture](docs/desktop-architecture.png) | ||
|
||
## Getting Started | ||
|
||
To clone and install all dependencies and start a process to re-build the app whenever you change a file: | ||
To clone and install all dependencies: | ||
|
||
```sh | ||
git clone [email protected]:digidem/mapeo-desktop.git | ||
cd mapeo-desktop | ||
npm install | ||
npm run build:translations | ||
``` | ||
|
||
Create a `.env` file at the project root that has the following structure (replace `<your_token_here>` with a valid [Mapbox public access token](https://docs.mapbox.com/help/getting-started/access-tokens/)): | ||
|
||
```env | ||
MAPBOX_ACCESS_TOKEN=<your_token_here> | ||
``` | ||
|
||
Start a process to re-build the app whenever you change a file: | ||
|
||
```sh | ||
npm run watch | ||
``` | ||
|
||
|
@@ -57,7 +68,6 @@ tail -f USERDATA/Mapeo/logs/$DATE.debug.log | |
|
||
See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for more details. | ||
|
||
|
||
## Community | ||
|
||
Connect with the Mapeo community for support & to contribute! | ||
|