overture-maps-dev-portal

Overture Maps Developer Portal & Documentation

Intended for developers who want to use the Overture Maps API to build applications, making use of the OVerture Maps Foundation datasets.

Provide a clear overview of the Overture Maps API
Show the API documentation inline and a link to download the OpenAPI specification
Guide developers on how to install the API on their own Infrastructure e.g. a GCP account with free credits
Provide examples of how to use the API
Provide an interactive demo app showing the API in use
Let developers sign up for their own API key to use the Cloud version
Link to community and support if they get stuck

This website is built using Docusaurus, a modern static website generator.

$ yarn

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.