{"id":18908813,"url":"https://github.com/orbitdb/repo-template","last_synced_at":"2025-06-24T10:33:50.652Z","repository":{"id":49825160,"uuid":"146602163","full_name":"orbitdb/repo-template","owner":"orbitdb","description":"A template for creating new repositories in the @orbitdb organization","archived":false,"fork":false,"pushed_at":"2021-05-07T14:54:09.000Z","size":13,"stargazers_count":24,"open_issues_count":4,"forks_count":29,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-31T12:26:23.237Z","etag":null,"topics":["docs","documentation","example","orbitdb","template"],"latest_commit_sha":null,"homepage":"","language":null,"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/orbitdb.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}},"created_at":"2018-08-29T13:14:39.000Z","updated_at":"2024-10-05T06:23:13.000Z","dependencies_parsed_at":"2022-09-24T07:01:30.824Z","dependency_job_id":null,"html_url":"https://github.com/orbitdb/repo-template","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/orbitdb%2Frepo-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Frepo-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Frepo-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Frepo-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orbitdb","download_url":"https://codeload.github.com/orbitdb/repo-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239896135,"owners_count":19714967,"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":["docs","documentation","example","orbitdb","template"],"created_at":"2024-11-08T09:28:46.624Z","updated_at":"2025-02-20T18:43:50.158Z","avatar_url":"https://github.com/orbitdb.png","language":null,"readme":"# Repo Template\n\n[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) [![Matrix](https://img.shields.io/badge/matrix-%23orbitdb%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io) \n\n\u003e A template for creating new repositories in the @orbitdb organization\n\nThis repository is meant to serve as a general template for how to set up new repositories in the @orbitdb organization. In general, setting up a new repository should take only a few minutes; use this repository as a way of finding example files, and use the following checklist to ensure that you've set up the repository correctly.\n\n## Install\n\nThese instructions are basic; you can use any method to do this work. The important part is making sure that you follow the checklist below before publishing the repository.\n\n```sh\n# Let's make a new folder\nmkdir new-repo \u0026\u0026 cd new-repo\n# Start a Git instance and copy over template files.\ngit init\ncp ../repo-template/* .\n# Overwrite this README\nmv README.md setup-checklist.md\nmv example-README.md README.md\n# Go over and check off the checklist, and finally\nrm setup-checklist\n```\n\n## Checklist\n\nGo through this checklist after creating your repository. It should only take a couple of minutes; if there is a way to make this more efficient, open an issue and let's talk about it here! \\m/\n\n### README\n- [ ] Copy `example-README.md` from this repository to your directory.\n- [ ] Rename all instances of `\u003cReplace Title\u003e` in README to match the new repo title\n- [ ] Manually go through and edit the rest of the README.\n\n### Other Files\n- [ ] Copy `CODE_OF_CONDUCT.md` verbatim.\n- [ ] Copy `CONTRIBUTING.md` and ensure that you've added any repository-specific instructions. (Replace `\u003cReplace Title\u003e` again).\n- [ ] Should you have a `CHANGELOG.md`? Document your release process, if you plan on having one, in the `CONTRIBUTING.md` file.\n\n### Dotfiles\n- [ ] Do you need a `.gitignore` file?\n- [ ] Do you need an `.npmignore` file?\n\n### License\n- [ ] Copy the MIT license from the example repo.\n- [ ] Is `Haja Networks Oy` the licensor?\n- [ ] Have you added `MIT` as the license in the `package.json`?\n- [ ] If you made changes, were these reflected in the last section of the README?\n\n### GitHub Metadata\n- [ ] Have you added a short description to the repository?\n  - [ ] Is the description matched in the byline under the title in the README?\n- [ ] Have you added topics to the GitHub repository: `orbitdb`, `orbit`, and so on?\n  - [ ] Have you added these topics as keywords in the `package.json`?\n\n### `package.json`\n\n- [ ] Is the `author` field correct?\n- [ ] Have you added `keywords`?\n- [ ] Are the `bugs` and `homepage` fields correct?\n- [ ] Have you added tests? Are they matched, here?\n- [ ] Have you added a `lint` command, if using [`eslint-config-orbitdb`](https://github.com/orbitdb/eslint-config-orbitdb)?\n\n### Tests\n\n- [ ] Are there automated tests?\n- [ ] ...for the browser as well?\n- [ ] Are those reflected in CI?\n- [ ] Bonus points: Using CircleCI workflows to segment tests?\n- [ ] Extra bonus points: Are you cross-testing dependencies (i.e. are changes in `orbit-db-keystore` tested in `orbit-db` as well\n\n### Benchmarks\n- [ ] Are there benchmarks?\n- [ ] Did you run the benchmarks before / after the change or PR?\n\n### Examples\n- [ ] Is there an example folder with usage examples?\n- [ ] For the browser as well?\n\n## Contribute\n\nIf you think this could be better, please [open an issue](https://github.com/orbitdb/repo-template/issues/new)!\n\nPlease note that all interactions in [@OrbitDB](https://github.com/orbitdb) fall under our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## License\n\n[MIT](LICENSE) © 2018 Haja Networks Oy\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbitdb%2Frepo-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forbitdb%2Frepo-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbitdb%2Frepo-template/lists"}