Skip to content
Snippets Groups Projects
Commit 3edfe283 authored by Bucknell, Mary S.'s avatar Bucknell, Mary S.
Browse files

Merge branch 'fix_readme' into 'main'

Updated README to include instructions on installing a npm package from gitlab.

See merge request !405
parents 27835b8f 543cefc3
No related branches found
No related tags found
1 merge request!405Updated README to include instructions on installing a npm package from gitlab.
......@@ -9,6 +9,21 @@ 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.
In addition, if someone has deleted the version that you are using and replaced it with a new build, you will likely get an EINTEGRITY error when using npm install. If this happens, uninstall @wma/wdfn-vue-components and then reinstall as follows:
```bash
npm uninstall @wma/wdfn-vue-components
npm install @wma/wdfn-vue-components --save-exact
```
### Installating dependencies using make
The repository contains a make target to configure a local development environment:
```bash
......
......@@ -3559,7 +3559,7 @@
"node_modules/@wma/wdfn-vue-components": {
"version": "0.1.0",
"resolved": "https://code.usgs.gov/api/v4/projects/8428/packages/npm/@wma/wdfn-vue-components/-/@wma/wdfn-vue-components-0.1.0.tgz",
"integrity": "sha1-TcKbpPmYqwM9CiPZCDXTgh56K0k=",
"integrity": "sha1-AOR2GoxyQLop1KnAaP7RFBHJUdU=",
"dependencies": {
"@uswds/uswds": "3.0.1",
"vue": "3.2.37"
......@@ -19967,7 +19967,7 @@
"@wma/wdfn-vue-components": {
"version": "0.1.0",
"resolved": "https://code.usgs.gov/api/v4/projects/8428/packages/npm/@wma/wdfn-vue-components/-/@wma/wdfn-vue-components-0.1.0.tgz",
"integrity": "sha1-TcKbpPmYqwM9CiPZCDXTgh56K0k=",
"integrity": "sha1-AOR2GoxyQLop1KnAaP7RFBHJUdU=",
"requires": {
"@uswds/uswds": "3.0.1",
"vue": "3.2.37"
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment