{"id":18584417,"url":"https://github.com/ipfs-examples/helia-nestjs","last_synced_at":"2025-11-01T21:30:33.256Z","repository":{"id":186931956,"uuid":"676006291","full_name":"ipfs-examples/helia-nestjs","owner":"ipfs-examples","description":"Using Helia with NestJS","archived":false,"fork":false,"pushed_at":"2024-10-08T07:01:49.000Z","size":18,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-26T17:44:51.742Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ipfs-examples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-08-08T08:11:54.000Z","updated_at":"2024-10-08T07:01:52.000Z","dependencies_parsed_at":"2024-01-19T16:42:42.762Z","dependency_job_id":"8534a0f9-0f74-4858-98f4-e4808c0f2f12","html_url":"https://github.com/ipfs-examples/helia-nestjs","commit_stats":null,"previous_names":["ipfs-examples/helia-nestjs"],"tags_count":0,"template":false,"template_full_name":"ipfs-examples/example-fork-go-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-examples%2Fhelia-nestjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-examples%2Fhelia-nestjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-examples%2Fhelia-nestjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-examples%2Fhelia-nestjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs-examples","download_url":"https://codeload.github.com/ipfs-examples/helia-nestjs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239331308,"owners_count":19621220,"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-07T00:27:27.758Z","updated_at":"2025-11-01T21:30:33.180Z","avatar_url":"https://github.com/ipfs-examples.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/ipfs/helia\" title=\"Helia\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png\" alt=\"Helia logo\" width=\"300\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003e\u003cb\u003eUsing Helia inside a NestJS app\u003c/b\u003e\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png\" width=\"200\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://ipfs.github.io/helia/modules/helia.html\"\u003eExplore the docs\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/ipfs-examples/helia-examples/issues\"\u003eReport Bug\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/ipfs-examples/helia-examples/issues\"\u003eRequest Feature/Example\u003c/a\u003e\n\u003c/p\u003e\n\n## About\n\nThis is an example of how to run [Helia](https://github.com/ipfs/helia) in a [NestJS](https://nestjs.com/) application.\n\nThis demo was created by running the `nest new` command to bootstrap a basic project.\n\nA few changes to the default project config were necessary:\n\n1. Ensure TypeScript outputs ESM and not CJS\n    - Please see the [helia-typescript](https://github.com/ipfs-examples/helia-typescript) example for more information\n2. Ensure Jest can run TypeScript ESM tests\n    - Please see the [helia-jest-typescript](https://github.com/ipfs-examples/helia-jest-typescript) example for more information\n\n## Getting Started\n\n### Prerequisites\n\nhttps://github.com/ipfs-examples/helia-examples#prerequisites\n\n### Installation and Running example\n\n```console\n\u003e npm install\n\u003e npm start\n```\n\nNow open your browser at `http://localhost:3000`\n\n### Available Scripts\n\nIn the project directory, you can run:\n\n#### `npm start`\n\nRuns the app in the development mode.\n\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\n\nYou will also see any lint errors in the console.\n\n#### `npm run build`\n\nBuilds the app for production to the `dist` folder.\n\nIt correctly bundles in production mode and optimizes the build for the best performance.\n\n#### `npm test`\n\nRuns the [Jest](https://www.npmjs.com/package/jest) unit test suite.\n\n#### `npm run test:e2e`\n\nRuns the [Jest](https://www.npmjs.com/package/jest) end-to-end test suite.\n\n## Usage\n\nThis is a [NestJS](https://nestjs.com/) project bootstrapped with [`nest new $project_name`](https://docs.nestjs.com/#installation) integrated with `helia`.\n\nYou can start editing the app by modifying `src/main.js`.\n\n### Learn More\n\nTo learn more about NestJS, take a look at the following resources:\n\n- [NestJS Documentation](https://docs.nestjs.com/) - learn about NestJS features and API.\n\n## Documentation\n\n- [IPFS Primer](https://dweb-primer.ipfs.io/)\n- [IPFS Docs](https://docs.ipfs.io/)\n- [Tutorials](https://proto.school)\n- [More examples](https://github.com/ipfs-examples/helia-examples)\n- [API - Helia](https://ipfs.github.io/helia/modules/helia.html)\n- [API - @helia/unixfs](https://ipfs.github.io/helia-unixfs/modules/helia.html)\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the IPFS Project\n2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)\n3. Commit your Changes (`git commit -a -m 'feat: add some amazing feature'`)\n4. Push to the Branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## Want to hack on IPFS?\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n\nThe IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:\n\nRead the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).\n\n- **Check out existing issues** The [issue list](https://github.com/ipfs/helia/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge\n- **Look at the [Helia Roadmap](https://github.com/ipfs/helia/blob/main/ROADMAP.md)** This are the high priority items being worked on right now\n- **Perform code reviews** More eyes will help\n  a. speed the project along\n  b. ensure quality, and\n  c. reduce possible future bugs\n- **Add tests**. There can never be enough tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-examples%2Fhelia-nestjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs-examples%2Fhelia-nestjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-examples%2Fhelia-nestjs/lists"}