{"id":19292142,"url":"https://github.com/nasa-pds/template-repo-nodejs","last_synced_at":"2025-06-21T23:04:57.470Z","repository":{"id":212874080,"uuid":"732130581","full_name":"NASA-PDS/template-repo-nodejs","owner":"NASA-PDS","description":"Template for new Node.js repositories for the Planetary Data System","archived":false,"fork":false,"pushed_at":"2024-12-03T06:15:18.000Z","size":177,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-24T00:17:55.157Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NASA-PDS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-15T18:09:10.000Z","updated_at":"2024-09-03T17:08:29.000Z","dependencies_parsed_at":"2024-01-08T22:30:01.332Z","dependency_job_id":"2dff4bbe-a0fe-4b82-9f70-a6930328b198","html_url":"https://github.com/NASA-PDS/template-repo-nodejs","commit_stats":null,"previous_names":["nasa-pds/template-repo-nodejs"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/NASA-PDS/template-repo-nodejs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Ftemplate-repo-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Ftemplate-repo-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Ftemplate-repo-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Ftemplate-repo-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NASA-PDS","download_url":"https://codeload.github.com/NASA-PDS/template-repo-nodejs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Ftemplate-repo-nodejs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261206104,"owners_count":23124837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T22:29:26.828Z","updated_at":"2025-06-21T23:04:52.459Z","avatar_url":"https://github.com/NASA-PDS.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PDS Template Repository for Node.js\n\nThis 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.\n4\n**👉 Note:** Please replace this entire `README.md` with text appropriate for your package!\n\n**👉 Also note:** Check _every_ other file and replace text appropriate for your package!\n\nThis `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 \u003ckbd\u003eUse this template\u003c/kbd\u003e button ↑ (or use [this hyperlink](https://github.com/NASA-PDS/template-repo-nodejs/generate)) and you've got a new repository already kitted-out with this template.\n\n\n## 🏃 Getting Started With This Template\n\nOur [wiki on Git and GitHub](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#creating-a-new-repo) has lots of useful information on setting up a new repository using the PDS Engineering Node templates.\n\n**👉 Important!** You must assign the teams as mentioned on the wiki page above! At a minimum, these are:\n\n| Team                                | Permission |\n| ----------------------------------- | ---------- |\n| `@NASA-PDS/pds-software-committers` | `write`    |\n| `@NASA-PDS/pds-software-pmc`        | `admin`    |\n| `@NASA-PDS/pds-operations`          | `admin`    |\n\nThis template was populated with [Vite](https://vitejs.dev) with [React](https://react.dev). If neither of these apply to your Node.js project, feel free to edit those out.\n\nWe recommend the use of [Node Version Manager (nvm)](https://github.com/nvm-sh/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](https://github.com/nvm-sh/nvm#installing-and-updating).***\n\nOnce your `nvm` installation has been [verified](https://github.com/nvm-sh/nvm/blob/master/README.md#verify-installation), configured, and activated (see the [NVM README](https://github.com/nvm-sh/nvm#readme)), you can run the following commands\n\n    nvm install 12.22.11\n    nvm use 12.22.11\n\nThis 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](https://github.com/nvm-sh/nvm#readme).\n\nBy 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:\n\n    nvm use\n\n**👉 Note:** If you're on Windows, [please see these important notes](https://github.com/nvm-sh/nvm#important-notes).\n\n\n---\n\n# 📽️ My Project\n\nThis is the XYZ that does this, that, and the other thing for the Planetary Data System.\n\nPlease visit our website at: https://nasa-pds.github.io/pds-my-project\n\nIt has useful information for developers and end-users.\n\n\n## 💽 Prerequisites\n\nHere, mention any system-wide requirements (`brew install`, `apt-get install`, `yum install`, …) needed to work with this ppackage.\n\n\n## 🏎️ User Quickstart\n\n(Here, give a guide to end-users how to quickly get up to speed with your package.)\n\nYou can quickly install this by typing\n\n    npm install\n\n(If possible, make it so that your program works out of the box without any additional configuration.)\n\n\nTo execute, run:\n\n    (put your run commands here)\n\n\n## ✋ Code of Conduct\n\nAll users and developers of the NASA-PDS software are expected to abide by our [Code of Conduct](https://github.com/NASA-PDS/.github/blob/main/CODE_OF_CONDUCT.md). Please read this to ensure you understand the expectations of our community.\n\n\n## 🔧 Development\n\nTo develop this project, use your favorite text editor, or an integrated development environment of your choice with Node.js support.\n\n\n### 👏 Contributing\n\nFor information on how to contribute to NASA-PDS codebases please take a look at our [Contributing guidelines](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md).\n\n\n### 🤫 Detecting Secrets\n\n(These instructions can probably stay as-is.)\n\nThe PDS Engineering Node recommends using [detect-secrets](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#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:\n\n    detect-secrets scan . \\\n        --all-files \\\n        --disable-plugin AbsolutePathDetectorExperimental \\\n        --exclude-files '\\.secrets..*' \\\n        --exclude-files '\\.git.*' \\\n        --exclude-files '\\.pre-commit-config\\.yaml' \\\n        --exclude-files 'node_modules' \u003e .secrets.baseline\n\nReview the `.secrets.baseline` to determine which should be allowed and which are false positives:\n\n    detect-secrets audit .secrets.baseline\n\nPlease remove any secrets that should not be seen by the public. You can then add the baseline file to the commit:\n\n    git add .secrets.baseline\n\nThen, configure the `pre-commit` hooks:\n\n    pre-commit install\n    pre-commit install -t pre-push\n    pre-commit install -t prepare-commit-msg\n    pre-commit install -t commit-msg\n\nThese hooks then will check for any future commits that might contain secrets.\n\n👉 **Note:** A one time setup is required both to support `detect-secrets` and in your global Git configuration. See [the wiki entry on Secrets](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#detect-secrets) to learn how.\n\n\n### 📦 Packaging\n\nEnter: `npm run build`.\n\n\n### 🩺 Tests\n\nUse `npm run tests`.\n\n\n## 📢 Publication\n\nThe continuous integration provided by the [Roundup Action](https://github.com/NASA-PDS/roundup-action/) takes care of this. But you can manually publish a release with `npm publish`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-pds%2Ftemplate-repo-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnasa-pds%2Ftemplate-repo-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-pds%2Ftemplate-repo-nodejs/lists"}