From 5c6e4dd55ad1ea7611390b5e81b2241f73cc1a61 Mon Sep 17 00:00:00 2001 From: mbucknel <mbucknell@usgs.gov> Date: Tue, 19 Jul 2022 14:31:11 -0500 Subject: [PATCH] Updated README to include instructions on installing a npm package from gitlab. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0ef3ca53c..a6bec087f 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,15 @@ The application has been developed using Python 3.8.x and Node.js 16.x. This is ## Install dependencies +### Using code.usgs.gov npm package registry +The package, [@wma/wdfn-vue-components](https://code.usgs.gov/groups/wma/-/packages), has been published on code.usgs.gov and is a dependency of this project. To install this package you will need to set up a personal access token on code.usgs.gov. The personal access token should have "api" scope. See [Authenticate to the Package Registry](https://code.usgs.gov/help/user/packages/npm_registry/index#authenticate-to-the-package-registry). We recommend that you add the _authToken npm setting in your user's .npmrc. Add the following to ~/.npmrc, substituting your personal access token. Your personal access token should not be put in the repo's .npmrc. That contains the location of the wma scoped registry. +``` +//code.usgs.gov/api/v4/packages/npm/:_authToken=<your personal access token> +``` + +You may also need to have the following environment variables set to a bundle that includes all certs for your environment including any corporate proxy cert: NPM_CONFIG_CAFILE and NODE_EXTRA_CA_CERTS + +### Installating dependencies using make The repository contains a make target to configure a local development environment: ```bash -- GitLab