{"id":13403053,"url":"https://github.com/server-state/template-module","last_synced_at":"2025-03-14T08:31:21.252Z","repository":{"id":35111302,"uuid":"206319871","full_name":"server-state/template-module","owner":"server-state","description":"Default template for server-base modules","archived":false,"fork":false,"pushed_at":"2023-05-01T22:58:28.000Z","size":2150,"stargazers_count":3,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-07-31T19:39:11.239Z","etag":null,"topics":["module","official","server","server-state","state","template"],"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/server-state.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-09-04T12:59:08.000Z","updated_at":"2023-05-19T11:24:37.000Z","dependencies_parsed_at":"2024-01-16T11:17:28.588Z","dependency_job_id":null,"html_url":"https://github.com/server-state/template-module","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/server-state%2Ftemplate-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/server-state%2Ftemplate-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/server-state%2Ftemplate-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/server-state%2Ftemplate-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/server-state","download_url":"https://codeload.github.com/server-state/template-module/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243547338,"owners_count":20308690,"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":["module","official","server","server-state","state","template"],"created_at":"2024-07-30T19:01:24.773Z","updated_at":"2025-03-14T08:31:20.893Z","avatar_url":"https://github.com/server-state.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# template-module\n\nDefault template for server-base modules\n\nThis output generates a straight base to provide other applications useful information like Server State example [Web Client](https://github.com/server-state/web-client).\n\n### Checklist for using this template\n\n- [ ] Change name and description in this README\n- [ ] Change the package name in the `package.json`\n- [ ] Change the repository, issue and other urls as well as the `author` field in the `package.json`, as needed\n- [ ] Familiarize yourself with the specifications for modules, which can be found in https://specs.server-state.tech/.\n\n**Afterwards**\n\n- [ ] Write source code for your module in the `src` module\n- [ ] Adjust the existing test in `tests/001-basic.test.js` so that your _SMF_ gets passed the necessery parameters and has the necessary mocks to pass. **Do not delete this test!** It is vital that the data you return is JSON-serializable and therefore, this test is required.\n- [ ] Write tests for your code (until you reach 100 % coverage, this has to get trusted to get deployed to production servers) in the tests folder\n\n**Afterwards**\n\n- [ ] Add all dependencies **you** have added as externals in the `webpack.config.js`\n- [ ] Run `npm run lint` (fix any errors that get shown)\n- [ ] Run `npm run test` (fix any errors that might occur)\n- [ ] Run `npm run build` (fix any errors that might occur)\n- [ ] Test by running `node` in the repo directory and requiring the module with `require('.')`. You can then test it interactively.\n- [ ] Publish as `v0.0.9` to npm to ensure CI can publish in the future (use `--access=public` for scoped packages\n- [ ] Bump version number in `package.json` to `0.1.0`, commit and push to GitHub\n- [ ] Add `gh_token` and `npm_token` to the GitHub repo secrets to allow CI publishing\n- [ ] Add a tag called `v0.1.0` and push it to GitHub\n- [ ] Watch GitHub actions publish the new version for you :wink:\n\n**For every new version**\n\n- [ ] Add all dependencies **you** have added as externals in the `webpack.config.js`\n- [ ] Run `npm run lint` (fix any errors that get shown)\n- [ ] Run `npm run test` (fix any errors that might occur)\n- [ ] Run `npm run build` (fix any errors that might occur)\n- [ ] Test by running `node` in the repo directory and requiring the module with `require('.')`. You can then test it interactively.\n- [ ] Bump version number in `package.json`\n- [ ] Add a tag called `v[package.json version number]` and push it to GitHub\n- [ ] Watch GitHub actions publish the new version for you :wink:\n\n---\n\nThis official module belongs to the organization [Server State](https://github.com/server-state).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserver-state%2Ftemplate-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserver-state%2Ftemplate-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserver-state%2Ftemplate-module/lists"}