REST API microservice to search for aggregated vessel information, such as characteristics and identifiers.

This is a nodejs express application built using swagger-node.

Most of the application settings are configured through environment variables. In your local development environment, you can setup those environment variales via the dev/env file, which is a standard docker env file. The actual settings are defined in config.js. We don't provide an env template since they usually fall out of sync of what's really needed to setup. Instead, read through the config.jsfile, as all the environment settings are described in detail there. In addition to this, if you attempt to start the application while missing some setting, the application won't start, and a helpful error will be printed to guide you to fix the issue.

We use a dockerized development environment, so you will need docker on your machine and also docker-compose. We also need the google cloud sdk installed locally to generate the authorization files that will be mounted on the docker container to authorize access to google cloud services. No other dependencies are required in your machine.

• Create a local application default credentials file in your local machine by running gcloud auth application-default login.
• Create an empty environment file at dev/env.
• Run docker-compose up. The application will fail to start, but will guide you to configure any missing settings you need to setup in the dev/env file.

This is a standard docker-compose project, so you can start all the necessary connected containers using docker-compose up. This will build images as needed and start a docker cluster with the webserver running on your local port 8080, and the debugging port open on your local port 5858.

If you need to run any npm-specific commands, run them inside the cluster with docker-compose run dev [COMMAND].

Copyright 2019 Global Fishing Watch

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.