ap3rture/navigator repository overview

⁠Navigator

⁠Configuration

./public/config.json contains configurations for the main tank and exhauster endpoint along with an optional MapBox Access key to make the geocoder work.

⁠Quickstart

• Create config.json
• Run container and mount config file: docker run --rm -it --name navigator --link tank -v /opt/navigator/config.json:/usr/share/nginx/html/config.json docker.pkg.github.com/aperture-sh/navigator/navigator:latest

⁠Deployment

• For a Aperture Infrastructure quickstart see README.md here Tank⁠.
• For production environments see our provisioning scripts using Ansible⁠ and Terraform⁠.

⁠Available Scripts

In the project directory, you can run:

⁠npm start

Runs the app in the development mode. Requests to /tank and /exhauster will be proxied to the ip address set in package.json using the proxy property.
Open http://localhost:3000⁠ to view it in the browser.

⁠npm run build

Builds the app for production to the build folder.

⁠License

Navigator is licensed under the Apache License, Version 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.