{"id":19024103,"url":"https://github.com/astrohelm/node-workspace","last_synced_at":"2026-01-02T01:10:22.475Z","repository":{"id":185141550,"uuid":"673072147","full_name":"astrohelm/node-workspace","owner":"astrohelm","description":"Astrohelm example of Nodejs workspace 📝","archived":false,"fork":false,"pushed_at":"2024-09-03T14:02:26.000Z","size":199,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-24T17:04:58.931Z","etag":null,"topics":["astrohelm","configuration","eslint","example","javascript","nodejs","preset","starter-kit","template","typescript"],"latest_commit_sha":null,"homepage":"https://astrohelm.ru","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/astrohelm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-31T20:05:40.000Z","updated_at":"2024-09-03T14:01:16.000Z","dependencies_parsed_at":"2023-09-12T22:12:22.601Z","dependency_job_id":"c8e65d29-6a7f-4865-82ef-5919a7b88209","html_url":"https://github.com/astrohelm/node-workspace","commit_stats":null,"previous_names":["astrohelm/workspace","astrohelm/node-workspace"],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astrohelm%2Fnode-workspace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astrohelm%2Fnode-workspace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astrohelm%2Fnode-workspace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astrohelm%2Fnode-workspace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/astrohelm","download_url":"https://codeload.github.com/astrohelm/node-workspace/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223752227,"owners_count":17196772,"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":["astrohelm","configuration","eslint","example","javascript","nodejs","preset","starter-kit","template","typescript"],"created_at":"2024-11-08T20:34:50.151Z","updated_at":"2026-01-02T01:10:22.435Z","avatar_url":"https://github.com/astrohelm.png","language":"JavaScript","readme":"\u003ch1 align=\"center\"\u003eAstrohelm default workspace\u003c/h1\u003e\n\n\u003ch2 align=\"center\"\u003eInstallation guide 🚀\u003c/h2\u003e\n\n### First step: workspace installation\n\nYou can use this repository as template - otherwise install it manually:\n\n```bash\n  # Download repository\n  git clone https://github.com/astrohelm/node-workspace\n  rm -rf ./path/to/workspace/.git ./path/to/workspace/package-lock.json\n  cd ./path/to/workspace/\n  # Update node.js (optional)\n  nvm install latest\n  nvm use latest\n  # Update and install dependencies\n  ncu -u\n  npm i\n```\n\n### Second step: Package personalization\n\nUpdate package json:\n\n- Replace all fields with prefix \u003ccode\u003eyour-\u003c/code\u003e\n- Update engines, if current is out of date\n- Remove browser field \u0026 dist folder, if you don't support it\n\n```js\n// package.json\n{\n  \"license\": \"MIT\",\n  \"version\": \"0.0.1\",\n  \"type\": \"commonjs\",\n  \"name\": \"your-package-name\",\n  \"homepage\": \"https://astrohelm.ru\",\n  \"description\": \"your-package-description\",\n  \"author\": \"your-name \u003cyour-mail\u003e\",\n  \"keywords\": [\"your-keyword #1\", \"your-keyword #n\"],\n\n  \"main\": \"index.js\",\n  \"types\": \"types/index.d.ts\",\n  \"packageManager\": \"npm@9.6.4\",\n  \"readmeFilename\": \"README.md\",\n  \"engines\": { \"node\": \"\u003e= 18\" },\n  \"browser\": {},\n  \"files\": [\"/dist\", \"/lib\", \"/types\"],\n\n  \"scripts\": {\n    \"test\": \"node --test \u0026\u0026 tsc\",\n    \"dev\": \"node index.js\",\n    \"prettier:fix\": \"prettier --write \\\"**/*.{js,ts,json,html,cjs,md,yaml}\\\"\",\n    \"eslint:fix\": \"eslint --fix \\\"**/*.{js,ts}\\\"\"\n  },\n\n  \"repository\": { \"type\": \"git\", \"url\": \"git+https://github.com/astrohelm/your-package-name.git\" },\n  \"bugs\": { \"url\": \"https://github.com/astrohelm/your-package-name/issues\", \"email\": \"your-mail\" },\n\n  \"devDependencies\": {\n    \"@types/node\": \"^18.15.10\",\n    \"eslint\": \"^8.40.0\",\n    \"eslint-config-astrohelm\": \"^1.0.0\",\n    \"eslint-config-prettier\": \"^8.8.0\",\n    \"eslint-plugin-prettier\": \"^4.2.1\",\n    \"prettier\": \"^2.8.8\",\n    \"typescript\": \"^5.0.2\"\n  }\n}\n```\n\n### Third step: About files\n\nGo to CHANGELOG.md and update it for your package. _WARNING !_ Don't forget about date (xxxx-xx-xx).\n\n```md\n\u003c!-- CHANGELOG.md --\u003e\n\n# Changelog\n\n## [Unreleased][unreleased]\n\n## [0.0.1][] - xxxx-xx-xx\n\n- Stable release version\n- Repository created\n\n[unreleased]: https://github.com/astrohelm/your-package-name/compare/v0.0.1...HEAD\n[0.0.1]: https://github.com/astrohelm/your-package-name/releases/tag/v0.0.1\n```\n\nUpdate AUTHORS\n\n```md\n \u003c!-- AUTHORS --\u003e\n\nyour-name \u003cyour-mail\u003e\n```\n\n### Almost last step: Update README.md\n\nReplace your README.md with next information and change Your-package-name to actual.\n\n```md\n\u003c!-- README.md --\u003e\n\u003ch1 align=\"center\"\u003eYour-package-name v0.0.1\u003c/h1\u003e\n\n\u003ch2 align=\"center\"\u003eInitial release 🚀\u003c/h2\u003e\n\n\u003ch2 align=\"center\"\u003eCopyright \u0026 contributors\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\nCopyright © 2023 \u003ca href=\"https://github.com/astrohelm/Your-package-name/graphs/contributors\"\u003eAstrohelm contributors\u003c/a\u003e.\nThis repository is \u003ca href=\"./LICENSE\"\u003eMIT licensed\u003c/a\u003e.\u003cbr/\u003e\nAnd it is part of \u003ca href=\"https://github.com/astrohelm\"\u003eAstrohelm ecosystem\u003c/a\u003e.\n\u003c/p\u003e\n```\n\n### Last step: Save results\n\n_WARNING !_ Update this file before moving throw this step.\n\nCreate a new package in [organization][https://github.com/astrohelm/] repository. Use next commands\nto save you package.\n\n```bash\ngit init\ngit remote add origin your-package-location\n# Start from here, if you used template\ngit branch -M main # if your default branch is not main\ngit commit -am \"Repository init\"\ngit tag v0.0.1\ngit push origin main\ngit push origin v0.0.1\ngit checkout -b dev\ngit push origin dev\n```\n\nReturn to your organization repository and do:\n\n- Add keywords\n- Update description\n- Draft release with `v0.0.1` tag and `v0.0.1` as a title and updated README file as description.\n\n\u003e If you want to create library you could publish it to npm with `npm publish` command.\n\nCongratulations, package initialized 🚀\n\n## About files \u0026 structure\n\nThis workspace have commonjs in use by default. You can switch it in package.json if you want.\n\n- `dist` directory used for fronted package analog. You can use it if your package is\n  multi-platform, [readme](./dist/README.md).\n- `eslint` astrohelm eslint rules\n- `types` .d.ts library types exports\n- `CHANGELOG.md` in use for project history documentation\n- `Makefile` ultimate commands shortcuts creator\n- `tests` here you can put all test coverage of your package\n- `.github` github ci pipeline by default\n- `lib` folder should contain all you library logic,**_WARNING !_** Remove if you not writing\n  library. Replace with **src** folder.\n\n\u003ch2 align=\"center\"\u003eCopyright \u0026 contributors\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\nCopyright © 2023 \u003ca href=\"https://github.com/astrohelm/node-workspace/graphs/contributors\"\u003eAstrohelm contributors\u003c/a\u003e.\nThis workspace is \u003ca href=\"./LICENSE\"\u003eMIT licensed\u003c/a\u003e.\u003cbr/\u003e\nAnd it is part of \u003ca href=\"https://github.com/astrohelm\"\u003eAstrohelm ecosystem\u003c/a\u003e.\n\u003c/p\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastrohelm%2Fnode-workspace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fastrohelm%2Fnode-workspace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastrohelm%2Fnode-workspace/lists"}