Awesome
<h1 align="center">OAM Landing Page</h1> <div align="center"> <h3> <a href="https://docs.openaerialmap.org/ecosystem/getting-started">Ecosystem</a> <span> | </span> <a href="https://github.com/hotosm/oam-catalog">Catalog API</a> <span> | </span> <a href="https://github.com/hotosm/oam-browser">Imagery Browser</a> </h3> </div>This is the landing page at openaerialmap.org. It receives stats from the OAM Catalog API.
Installation and Usage
The steps below will walk you through setting up your own instance of the openaerialmap.org.
Install Project Dependencies
To set up the development environment for this website, you'll need to install the following on your system:
Install Application Dependencies
If you use nvm
, activate the desired Node version:
nvm install
Install Node modules:
npm install
Usage
Config files
All the config files can be found in app/assets/scripts/config
.
After installing the projects there will be 3 main files:
local.js
- Used only for local development. On production this file should not exist or be empty.staging.js
production.js
The production.js
file serves as base and the other 2 will override it as needed:
staging.js
will be loaded whenever the env variableDS_ENV
is set to staging.local.js
will be loaded if it exists.
The following options must be set: (The used file will depend on the context)
OAMCatalogAPI
- The url of OAM Catalog.OAMBrowserUrl
- The url of OAM Browser.
Example:
module.exports = {
OAMBrowserUrl: 'https://beta.openaerialmap.org',
OAMCatalogApi: 'https://api.openaerialmap.org'
};
Starting the app
npm run serve
Compiles the sass files, javascript, and launches the server making the site available at http://localhost:3000/
The system will watch files and execute tasks whenever one of them changes.
The site will automatically refresh since it is bundled with livereload.
Deployment
To prepare the app for deployment run:
npm run build
This will package the app and place all the contents in the dist
directory.
The app can then be run by any web server.
License
Openaerialmap is licensed under BSD 3-Clause License, see the LICENSE file for more details.