Spatial Data Infrastructure for Planetary Missions
- Web-based mapping interface
- 2D slippy map
- 3D globe with tiled height data
- Image viewer capable of showing mosaics with targets
- 5 fully customizable layer types
- Easy to use CMS
- Multi-user vector drawing
- Elevation profiler
- Custom projections
- Tiling scripts
- And so much more...
To build the Docker image, run:
docker build -t <image tag> .
This repo contains a docker-compose.yml
file that defines a service for the application and a PostgreSQL database with PostGIS installed
-
Copy
/sample.env
to.env
cp sample.env .env
-
Open
.env
and update the following:DB_NAME=<name> DB_USER=<user> DB_PASS=<password>
From the install example:
DB_NAME=db DB_USER=postgres DB_PASS=<POSTGRES_PASSWORD (see below)>
-
Set all the ENV variables in
.env
. More information about the ENVs can be found here.- If using the postgis/postgres image from within the docker-compose.yml, set the ENV
DB_NAME
to the name of the service (in this casedb
)
- If using the postgis/postgres image from within the docker-compose.yml, set the ENV
-
In the
db
service indocker-compose.yml
, set thePOSTGRES_PASSWORD
environment variable and use this for MMGIS'sDB_PASS
ENV value. -
To run MMGIS in a container, you need to create a directory on the host machine and map this to a directory in the container.
- On the host machine, create a
Missions
directory and copy the contents of./Missions
to your directory. - Via the docker-compose.yml, map this directory to
/usr/src/app/Missions
in the container. For example, if the host directory is./Missions
, the volume mapping would be- ./Missions:/usr/src/app/Missions
- On the host machine, create a
Run: docker-compose up
-
Setup the admin account:
- In your browser, navigate to
http://localhost:8888/configure
- Sign up for an Administrator account (The Administrator account is always the first user in the database and you are only prompted to create an Administrator account if there are no other users)
- In your browser, navigate to
-
Now sign in with you Administrator credentials
-
Click
NEW MISSION
Enter a new mission name and clickMAKE MISSION
Optiona;" (Use the mission name"Test"
(case-sensitive) to make the sample mission)
Navigate to http://localhost:8888
.
See the configuration documentation for more information on how to use the configure page to customize and add data to MMGIS.
-
Install the latest version of Node.js v20.11.1+.
-
Install PostgreSQL v10.14+. Detailed install instructions for all platforms.
-
Install PostGIS 2.5+. From the above install, you can use the 'Application Stack Builder' to install PostGIS or the default PostGIS install instructions for all platforms.
-
Make a new PostgreSQL database and remember the user, password and database name. Use 'psql' or the 'SQL Shell' to log into Postgres. It will prompt you for the username and password made during the install.
-
GDAL and Python are weaker dependencies (desirable but, without them, not everything will work)
/
will always refer to the repo's root directory
-
Clone the repo
git clone https://github.com/NASA-AMMOS/MMGIS
-
From within
/
npm install
-
Copy
/sample.env
to.env
cp sample.env .env
-
Open
.env
and update the following:DB_NAME=<name> DB_USER=<user> DB_PASS=<password>
From the install example:
DB_NAME=mmgis DB_USER=postgres DB_PASS=<password>
-
Run
npm run build
to bundle up the code (first time or if there are any changes) -
Go into /configure and run
npm install
followed bynpm run build
to build the beta configuration site. -
Go back to the root
/
directory -
Run
npm run start:prod
-
Setup the admin account:
- In your browser, navigate to
http://localhost:8888/configure
- Sign up for an Administrator account (The Administrator account is always the first user in the database and you are only prompted to create an Administrator account if there are no other users)
- In your browser, navigate to
-
Now sign in with you Administrator credentials
-
Click
NEW MISSION
Enter a new mission name and clickMAKE MISSION
(Use the mission name"Test"
(case-sensitive) to make the sample mission)
Go to http://localhost:8888
to see the Test
mission
Note: The development environment (npm start
) and only the development environment uses two port numbers 8888
and 8889
(by default) — the latter for the main site and the former for the ancillary pages (such as /configure
and /docs
)
-
Run
npm run build
to bundle up the code (first time or if there are any changes) -
Run
npm run start:prod
- Run
npm start
- Run
npm run test
Note: Jest has just been added in v2.0.0 and test suites are still very limited. There is strong interest to move to Playwright.
Additionally, documentation pages are served at http://localhost:8888/docs
or immediately within the docs/pages/markdowns
directory.
Check out our contributing guide here.
Check out our code of conduct here.
License: Apache 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
Copyright (c) 2024, California Institute of Technology ("Caltech"). U.S. Government sponsorship acknowledged.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Dr. Fred J. Calef III - [email protected]
Tariq K. Soliman - [email protected]
Or join us on Slack