{"id":13406738,"url":"https://github.com/nodegui/nodegui-starter","last_synced_at":"2025-08-02T08:05:18.704Z","repository":{"id":40705658,"uuid":"199719100","full_name":"nodegui/nodegui-starter","owner":"nodegui","description":"A starter repo for NodeGui projects","archived":false,"fork":false,"pushed_at":"2024-02-17T09:26:29.000Z","size":460,"stargazers_count":123,"open_issues_count":13,"forks_count":32,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-06-01T06:17:54.131Z","etag":null,"topics":["cross-platform","desktop","gui","nodejs","qt"],"latest_commit_sha":null,"homepage":null,"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/nodegui.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}},"created_at":"2019-07-30T20:01:52.000Z","updated_at":"2024-06-07T23:18:19.000Z","dependencies_parsed_at":"2024-04-16T04:46:18.202Z","dependency_job_id":"776e5c61-a8c8-44a6-b34a-e6630bdab726","html_url":"https://github.com/nodegui/nodegui-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/nodegui/nodegui-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fnodegui-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fnodegui-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fnodegui-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fnodegui-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodegui","download_url":"https://codeload.github.com/nodegui/nodegui-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fnodegui-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268351038,"owners_count":24236331,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cross-platform","desktop","gui","nodejs","qt"],"created_at":"2024-07-30T19:02:37.969Z","updated_at":"2025-08-02T08:05:18.669Z","avatar_url":"https://github.com/nodegui.png","language":"TypeScript","readme":"## :warning: This starter repository isn't being actively maintained. :point_right: Go to [nodegui-simple-starter](https://github.com/sedwards2009/nodegui-simple-starter) for a modern starter template.\n\n\n# nodegui-starter\n\n**Clone and run for a quick way to see NodeGui in action.**\n\n## To Use\n\nTo clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer.\n\nMake sure you have met the requirements listed here: https://docs.nodegui.org/docs/guides/getting-started#developer-environment\n\nFrom your command line:\n\n```bash\n# Clone this repository\ngit clone https://github.com/nodegui/nodegui-starter\n# Go into the repository\ncd nodegui-starter\n# Install dependencies\nnpm install\n# Run the app\nnpm start\n```\n\n## Resources for Learning NodeGui\n\n- [docs.nodegui.org](https://nodegui.github.io/nodegui) - all of NodeGui and React Desktop's documentation\n\n## Packaging app as a distributable\n\nIn order to distribute your finished app, you can use [@nodegui/packer](https://github.com/nodegui/packer)\n\n### Step 1: (_**Run this command only once**_)\n\n```sh\nnpx nodegui-packer --init MyAppName\n```\n\nThis will produce the deploy directory containing the template. You can modify this to suite your needs. Like add icons, change the name, description and add other native features or dependencies. Make sure you commit this directory.\n\n### Step 2: (_**Run this command every time you want to build a new distributable**_)\n\nNext you can run the pack command:\n\n```sh\nnpm run build\n```\n\nThis will produce the js bundle along with assets inside the `./dist` directory\n\n```sh\nnpx nodegui-packer --pack ./dist\n```\n\nThis will build the distributable using @nodegui/packer based on your template. The output of the command is found under the build directory. You should gitignore the build directory.\n\nMore details about packer can be found here: https://github.com/nodegui/packer\n\n## License\n\nMIT\n","funding_links":[],"categories":["TypeScript","Boilerplates"],"sub_categories":["Samples and Experiments"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodegui%2Fnodegui-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodegui%2Fnodegui-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodegui%2Fnodegui-starter/lists"}