{"id":22862375,"url":"https://github.com/hq20/create-hq20-dapp","last_synced_at":"2025-04-30T22:03:49.647Z","repository":{"id":37945910,"uuid":"192419959","full_name":"HQ20/create-hq20-dapp","owner":"HQ20","description":":herb: This is the TechHQ dapp starter kit :octocat: All you need in a nut:shell:","archived":false,"fork":false,"pushed_at":"2023-01-07T18:19:45.000Z","size":8721,"stargazers_count":28,"open_issues_count":52,"forks_count":11,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-20T13:56:36.710Z","etag":null,"topics":["boilerplate","client","contracts","ethereum","react","smart","smat-contracts","template","ts","typescript"],"latest_commit_sha":null,"homepage":"https://www.techhq.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HQ20.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":"SECURITY.md","support":null}},"created_at":"2019-06-17T21:16:22.000Z","updated_at":"2024-07-18T09:33:11.000Z","dependencies_parsed_at":"2023-02-07T20:15:37.290Z","dependency_job_id":null,"html_url":"https://github.com/HQ20/create-hq20-dapp","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fcreate-hq20-dapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fcreate-hq20-dapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fcreate-hq20-dapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fcreate-hq20-dapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HQ20","download_url":"https://codeload.github.com/HQ20/create-hq20-dapp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229524501,"owners_count":18086550,"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":["boilerplate","client","contracts","ethereum","react","smart","smat-contracts","template","ts","typescript"],"created_at":"2024-12-13T10:13:10.805Z","updated_at":"2024-12-13T10:13:11.389Z","avatar_url":"https://github.com/HQ20.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg style=\"\" width=\"768\" src=\"title.webp\"\u003e\n\u003c/div\u003e\n\n\u003e Welcome to HQ20 create-hq20-dapp. With a couple of different templates from a basic setup for smart contracts development, a react webui and an api with cache server. This is great for every new project. Contains examples of tests, coverage, documentation generators, linters, etc.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cdiv\u003e\n        \u003ca\n            href=\"https://travis-ci.org/HQ20/create-hq20-dapp\"\u003e\u003cimg\n                src=\"https://travis-ci.org/HQ20/create-hq20-dapp.svg?branch=master\" /\u003e\u003c/a\u003e\u0026emsp;\n        \u003ca\n            href=\"https://dependabot.com\"\u003e\u003cimg\n                src=\"https://api.dependabot.com/badges/status?host=github\u0026repo=HQ20/contracts\" /\u003e\u003c/a\u003e\u0026emsp;\n    \u003c/div\u003e\n\u003c/div\u003e\n\n## Quick Overview\n\n```sh\nnpx create-hq20-dapp my-app\ncd my-app\nnpm start\n```\n\nThe following templates are available:\n- **smart-contracts** an example of a solidity smart contracts project\n- **react-webui** using a *create-react-app* boilerplate with typescript and ethers.js connecting to a local network\n- **api** an api with a cache server built with express.js and postgresql database, listening and caching events.\n\n## Usage\n\n**You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects.\n\nTo create a new app:\n\n### Yarn\n\n```sh\nyarn create hq20-dapp my-app\n```\n\n_[`yarn create \u003cstarter-kit-package\u003e`](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_\n\nIt will create a directory called `my-app` inside the current folder.\u003cbr\u003e\nInside that directory, it will generate the initial project structure and install the transitive dependencies:\n\n```\nmy-app\n├── README.md\n├── node_modules\n├── package.json\n├── .gitignore\n├── react-webui\n│   ├── (to complete)\n│   └── (to complete)\n├── smart-contracts\n│   └── (to complete)\n└── api\n    └── (to complete)\n```\n\nNo configuration or complicated folder structures, only the files you need to build your app.\u003cbr\u003e\nOnce the installation is done, you can open your project folder:\n\n```sh\ncd my-app\n```\n\nInside the newly created project, you can run some built-in commands:\n\nThis is a step-by-step on how to get all the workspaces working, but of course, you might not want to run the android app, so, no need to install the dependencies on that workspace. Or, you might not want to start the cache server, so you can ignore steps 3, 5 and 6. That's up to you what to run. But whatever that is, it must be it the order shown above.\n\n## Repository updates\n\nThis repository has automatic updates, thanks to [dependabot](https://dependabot.com), with an exception to **react-webui** template. We choose to only allow to update **react-scripts** and **security** issues, with no automatic merges because that template highly relies on [CRA](https://github.com/facebook/create-react-app).\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[Apache-2.0](LICENSE)\n\n## Credits\n* Icons made by \u003ca href=\"https://www.flaticon.com/authors/srip\" title=\"srip\"\u003esrip\u003c/a\u003e from \u003ca href=\"https://www.flaticon.com/\" title=\"Flaticon\"\u003e www.flaticon.com\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhq20%2Fcreate-hq20-dapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhq20%2Fcreate-hq20-dapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhq20%2Fcreate-hq20-dapp/lists"}