{"id":20806310,"url":"https://github.com/nodesource/nsolid-npm","last_synced_at":"2025-05-07T04:24:17.674Z","repository":{"id":57312313,"uuid":"357671320","full_name":"nodesource/nsolid-npm","owner":"nodesource","description":"Using N|Solid runtime without installing it officially","archived":false,"fork":false,"pushed_at":"2024-03-01T20:05:20.000Z","size":864,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-01T21:17:17.284Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodesource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-13T19:49:16.000Z","updated_at":"2023-07-15T22:23:17.000Z","dependencies_parsed_at":"2024-06-19T14:59:19.901Z","dependency_job_id":"e12c5a5e-af54-4055-a3c4-efef1e993a09","html_url":"https://github.com/nodesource/nsolid-npm","commit_stats":{"total_commits":31,"total_committers":4,"mean_commits":7.75,"dds":0.4516129032258065,"last_synced_commit":"626e3ec954b742a7c903aa0c6c589860b521657a"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-npm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-npm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-npm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-npm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodesource","download_url":"https://codeload.github.com/nodesource/nsolid-npm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252811434,"owners_count":21807936,"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-17T19:19:15.243Z","updated_at":"2025-05-07T04:24:17.654Z","avatar_url":"https://github.com/nodesource.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![N|Solid](https://s3.amazonaws.com/assets.nodesource.com/nsolid-logo-dark%402x.png)](https://nodesource.com/products/nsolid)\n\nN|Solid From NPM\n=====================\n\n## Description\n\nThis module is intended to be used as a quickstart with **N|Solid SaaS** platform and also works in restricted environments where **N|Solid runtime** is not installed. \n\nSee [examples](./examples) of how to use it.\n\n## Requirements\n\n- We only support LTS versions, so this will fail for stable Node.js versions.\n- Shouldn't you have a valid **N|Solid SaaS** license, consider [downloading and installing](https://downloads.nodesource.com/) the `N|Solid for desktop` on your local machine.\n## Installation\n\nInstall the module for your project as a regular dependency:\n\n```bash\nnpm install nsolid\n```\n\nor using npx:\n\n```bash\nnpx nsolid\n```\n## Usage\n\n- TL;DR: Check out our [examples](./examples) page.\n\n\n### How to add nsolid to an existent project\n\n- Run `npm install nsolid` on the `package.json`'s project location\n- Replace the `node` command with `nsolid` at the desired npm scripts executing the applications you want to connect to the N|Solid Console, like this\n\n  __before__:\n  ```json\n    \"scripts\": {\n      \"start\": \"node index.js\",\n      \"test\": \"echo \\\"Error: no test specified\\\" \u0026\u0026 exit 1\"\n    },\n  ```\n\n  __after__:\n  ```json\n    \"scripts\": {\n      \"start\": \"nsolid index.js\",\n      \"test\": \"echo \\\"Error: no test specified\\\" \u0026\u0026 exit 1\"\n    },\n  ```\n\n### How to get my N|Solid Command URL\n#### Instructions for N|Solid Local Instance\n\n- The command for N|Solid Desktop is `localhost:9001`\n- The URL for N|Solid Console is `http://localhost:6753`\n\n#### Instructions for N|Solid SaaaS\n\n- Go to your [Node Source account](https://accounts.nodesource.com/downloads) and choose the `NodeSource - SaaS` account as the print below\n\n![](./resources/01-initial-page.png)\n\n- You should see the same page as below:\n\n![](./resources/02-saas-console-url.png)\nThe page shows you the Console URL and the NodeSource SaaS command that you'll need to link your app\nwhere: \n1. The console URL available to copy it\n2. a button to visit the console page\n3. your account N|Solid command address \n\nCopy the the **command address** to use it on the next section.\n### How to link your Node.js app to a N|Solid Console\n\n- In order to link your current application to the desired **N|Solid Console** you must add configuration properties either on your `package.json` or using the `NSOLID_COMMAND`, for local N-Solid instance,  or `NSOLID_SAAS` environment variables on your machine. See our [examples](./examples).\n\n\n- Should you add the configuration on your current `package.json` file, it should look as follows:\n\n  __before__:\n  ```json\n    \"scripts\": {\n      \"start\": \"nsolid index.js\"\n    },\n  ```\n\n  __after__:\n  ```json\n    \"scripts\": {\n      \"start\": \"nsolid index.js\"\n    },\n    \"nsolid\": {\n      \"saas\": \"YOUR N|Solid SaaS URL\"\n    }\n  ```\n  or for local N|Solid instance: \n\n  __after__:\n  ```json\n    \"scripts\": {\n      \"start\": \"nsolid index.js\"\n    },\n    \"nsolid\": {\n      \"command\": \"localhost:9001\"\n    }\n\n  ```\n\n*For more information on these settings please go to [https://docs.nodesource.com/nsolid/4.5/docs#nsolid-runtime](https://docs.nodesource.com/nsolid/4.6/docs#nsolid-runtime)*\n\n- Then, after running `npm start` command, go back to the browser and visit the console (as shown on the previous section).\n- Your *N|Solid Console* show the apps you've linked as follows:\n\n![](./resources/03-metrics-working.png)\n\n*If you're running the N|Solid Console locally, you just need to open the URL `http://localhost:6753` and you should see the same page as above.*\n\n## How it works\n\nIt downloads the latest version of the runtime matching the current Node.js LTS used in the local Node.js installation. \n\nThe download happens at the `postinstall` process of this module, then proceeds to extract and put the runtime files at the current user's home directory inside a folder like `.nsolid-runtime/nsolid-fermium` to be used later by an __NPM command__.\n\nThe module includes a command called `nsolid`, which is designed to replace the `node` command __inside an NPM script__ and then executes the original task using the N|Solid binary previously downloaded at the postinstall phase.\n\nCurrently, this module supports Linux, Windows, and Mac.\n## Contributing\n\nTo submit a bug report, please create an [issue at GitHub](https://github.com/nodesource/nsolid-npm/issues/new).\n\nContributions are always welcome!\n\n## License \u0026 Copyright\n\n**nsolid-npm** is Copyright (c) 2021 NodeSource and licensed under the\nMIT license. All rights not explicitly granted in the MIT license are reserved.\nSee the included [LICENSE.md](./LICENSE.md) file for more details.\n\nThe projects contained within the **nsolid-npm** images maintain their own Licenses.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fnsolid-npm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodesource%2Fnsolid-npm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fnsolid-npm/lists"}