This repository provides the implementation of the NIST Science Data Portal (SDP) platform, the technology that provides the NIST Science Data Portal (SDP). One of its main functions is to provide web site for searching for NIST data products.
angular --> Angular (Typescript) source code
scripts --> Tools for running the services and running all tests
oar-build --> general oar build system support (do not customize)
docker/ --> Docker containers for building and running tests
As a Javascript/Typescript application, this product is built and run using node and npm.
- node 16.17.1 or higher
All prerequisite Javascript modules needed are provided via the npm build tool. See angular/package.json for a listing of primary dependencies and angular/package-lock.json for a complete listing of all dependencies.
As a standard OAR repository, the software products can be built by simply via the makedist script, assuming the prerequisites are installed:
scripts/makedist
The built products will be written into the dist subdirectory (created by the makedist); each will be written into a zip-formatted file with a name formed from the product name and a version string.
Additional options are available; use the -h option to view the details:
scripts/makedist -h
Assuming the prerequisites are installed, the testall script can be used to execute all unit and integration tests:
scripts/testall
Like with makedist, you can run the tests for the different products separately by listing the desired product names as arguments to testall. Running testall -h will explain available command-line options.
The makedist and testall scripts are simply wrappers around the native build tools for the products--namely, npm. You can use these tools directly to build and test. Consult the README.md files in the angular directory for more details.
Like all standard OAR repositories, this repository supports the use of Docker to build the software and run its tests. (This method is used at NIST in production operations.) The advantage of the Docker method is that it is not necessary to first install the prerequisites; this are installed automatically into Docker containers.
To build the software via a docker container, use the makedist.docker script:
scripts/makedist.docker
Similarly, testall.docker runs the tests in a container:
scripts/testall.docker
Like their non-docker counterparts, these scripts accept product names as arguments.
Consult the README.md files in the angular directory for details on how to launch the services provided by the software products.
This software was developed by employees and contractors of the National Institute of Standards and Technology (NIST), an agency of the Federal Government and is being made available as a public service. Pursuant to title 17 United States Code Section 105, works of NIST employees are not subject to copyright protection in the United States. This software may be subject to foreign copyright. Permission in the United States and in foreign countries, to the extent that NIST may hold copyright, to use, copy, modify, create derivative works, and distribute this software and its documentation without fee is hereby granted on a non-exclusive basis, provided that this notice and disclaimer of warranty appears in all copies.
THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.