This is the template repository for PDS's Node.js projects. The goal of this repository is to be a base of Node.js repositories developed by the Planetary Data System.
4
👉 Note: Please replace this entire README.md with text appropriate for your package!
👉 Also note: Check every other file and replace text appropriate for your package!
This README.md documents the template repository and contains instructions on how to use it after you've duplicated the template into a new project-specific repository. How do you do that? Simply click the Use this template button ↑ (or use this hyperlink) and you've got a new repository already kitted-out with this template.
Our wiki on Git and GitHub has lots of useful information on setting up a new repository using the PDS Engineering Node templates.
👉 Important! You must assign the teams as mentioned on the wiki page above! At a minimum, these are:
| Team | Permission |
|---|---|
@NASA-PDS/pds-software-committers |
write |
@NASA-PDS/pds-software-pmc |
admin |
@NASA-PDS/pds-operations |
admin |
This template was populated with Vite with React. If neither of these apply to your Node.js project, feel free to edit those out.
We recommend the use of Node Version Manager (nvm), since different projects within the Planetary Data System require different versions of Node.js. This tool allows you to use a specific version of Node.js for each terminal session on your machine. If you haven't already, install or update nvm.
Once your nvm installation has been verified, configured, and activated (see the NVM README), you can run the following commands
nvm install 12.22.11
nvm use 12.22.11
This configures your PATH in your current terminal session so node --version prints v12.22.11. There are convenient shortcuts for LTS versions; again see the NVM README.
By default, this template includes a .nvmrc file that contains lts/*, meaning "use the latest long-term support release". Feel free to adjust this as needed. To activate Node.js using the .nvmrc file, in a terminal window, navigate to where you have cloned this repository and execute the following command, paying close attention to any additional instructions it may provide:
nvm use
👉 Note: If you're on Windows, please see these important notes.
This is the XYZ that does this, that, and the other thing for the Planetary Data System.
Please visit our website at: https://nasa-pds.github.io/pds-my-project
It has useful information for developers and end-users.
Here, mention any system-wide requirements (brew install, apt-get install, yum install, …) needed to work with this ppackage.
(Here, give a guide to end-users how to quickly get up to speed with your package.)
You can quickly install this by typing
npm install
(If possible, make it so that your program works out of the box without any additional configuration.)
To execute, run:
(put your run commands here)
All users and developers of the NASA-PDS software are expected to abide by our Code of Conduct. Please read this to ensure you understand the expectations of our community.
To develop this project, use your favorite text editor, or an integrated development environment of your choice with Node.js support.
For information on how to contribute to NASA-PDS codebases please take a look at our Contributing guidelines.
(These instructions can probably stay as-is.)
The PDS Engineering Node recommends using detect-secrets in order to prevent credentials, private email addresses, application keys, etc., from leaking into the commit history. To use detect-secrets, install the tool according to the instructions in the wiki. Then, make a baseline for any secrets that are supposed to be in repository:
detect-secrets scan . \
--all-files \
--disable-plugin AbsolutePathDetectorExperimental \
--exclude-files '\.secrets..*' \
--exclude-files '\.git.*' \
--exclude-files '\.pre-commit-config\.yaml' \
--exclude-files 'node_modules' > .secrets.baseline
Review the .secrets.baseline to determine which should be allowed and which are false positives:
detect-secrets audit .secrets.baseline
Please remove any secrets that should not be seen by the public. You can then add the baseline file to the commit:
git add .secrets.baseline
Then, configure the pre-commit hooks:
pre-commit install
pre-commit install -t pre-push
pre-commit install -t prepare-commit-msg
pre-commit install -t commit-msg
These hooks then will check for any future commits that might contain secrets.
👉 Note: A one time setup is required both to support detect-secrets and in your global Git configuration. See the wiki entry on Secrets to learn how.
Enter: npm run build.
Use npm run tests.
The continuous integration provided by the Roundup Action takes care of this. But you can manually publish a release with npm publish.