{"id":19401232,"url":"https://github.com/mishamyrt/nuga-app","last_synced_at":"2025-04-24T07:30:39.174Z","repository":{"id":180197908,"uuid":"658103225","full_name":"mishamyrt/nuga-app","owner":"mishamyrt","description":"⌨️ NuPhy® keyboard configurator","archived":false,"fork":false,"pushed_at":"2024-05-04T09:55:00.000Z","size":1837,"stargazers_count":52,"open_issues_count":3,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-03T01:01:52.897Z","etag":null,"topics":["keyboard","nuphy","wails"],"latest_commit_sha":null,"homepage":"https://nuga.myrt.co","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mishamyrt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-24T19:22:08.000Z","updated_at":"2025-02-21T08:55:00.000Z","dependencies_parsed_at":"2024-01-10T09:31:42.113Z","dependency_job_id":"5c9f34c1-a00d-4faf-ba21-b59a8d09bfbe","html_url":"https://github.com/mishamyrt/nuga-app","commit_stats":null,"previous_names":["mishamyrt/nuga","mishamyrt/nuga-app"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishamyrt%2Fnuga-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishamyrt%2Fnuga-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishamyrt%2Fnuga-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishamyrt%2Fnuga-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mishamyrt","download_url":"https://codeload.github.com/mishamyrt/nuga-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250582788,"owners_count":21453913,"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":["keyboard","nuphy","wails"],"created_at":"2024-11-10T11:17:38.545Z","updated_at":"2025-04-24T07:30:38.251Z","avatar_url":"https://github.com/mishamyrt.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nuga [![Quality assurance](https://github.com/mishamyrt/Nuga/actions/workflows/quality-assurance.yaml/badge.svg)](https://github.com/mishamyrt/Nuga/actions/workflows/quality-assurance.yaml)\n\nApplication for controlling NuPhy® keyboards.\n\n\u003cimg src=\"https://nuga.myrt.co/window.png\" width=\"800px\" /\u003e\n\n### Features\n\n- Lights control.\n- Key mapping control (Halo75 and Halo65 for now).\n- Macros control.\n\n**Supported devices**: Halo75, Halo65, Halo96.\n\n## Installation\n\n### macOS\n\n1. Download the zip archive labeled `mac` from the [latest release](https://github.com/mishamyrt/Nuga/releases/latest).\n2. Unzip the archive, copy `Nuga.app` to Applications.\n3. Launch `Nuga.app`.\n4. The application requests permission to Input Monitoring. This is required to work with the USB HID device. Grant permission.\n5. Restart the app\n\n## Development\n\nFor local development, you need to set up environments. For this purpose you will need:\n\n- [golang](https://go.dev/doc/install)\n- [Wails](https://wails.io/docs/gettingstarted/installation)\n- [pnpm](https://pnpm.io/installation)\n\n### Libraries\n\n#### macOS\n\n```sh\nbrew install hidapi\n```\n\n### Starting\n\nTo run a local application, the target `dev` is used:\n\n```sh\nmake dev\n```\n\nIf you want to run another OS interface on macOS, you should run the `dev-universal` target:\n\n```sh\nmake dev-universal\n```\n\n### Build\n\nCross-compiling the application is not possible at this time. Therefore, full build is only possible on macOS. A native build for macOS can be built on macs with Intel® and Apple Silicon™ processors , Linux version is built on either macOS (via Docker) or the amd64 version of Linux.\n\nFor native builds, there are targets in the Makefile:\n\n- `build/darwin` – To build macOS app (arm64, amd64)\n- `build/linux` – To build Linux app binary (arm64, amd64)\n\nThe `build` command is a common alias for these commands and performs a build on the OS that is currently in use.\n\n```sh\nmake build\n```\n\nThe result of the build will be archives with the application in the `dist` or `app/build/bin` folder.\n\n### Release\n\nTo publish a new release, set version in [Makefile](./Makefile) and run:\n\n```\nmake publish\n```\n\nAutomatic build, signing and notarization will be started. Once the build is complete, the files will be attached to the created GitHub Release.\n\nThe release description is compiled automatically from the [CHANGELOG.md](./CHANGELOG.md) file.\n\n### Linux cross-compilation\n\nThe Linux version can be built on macOS using Docker. To build an image with the toolkit, run the command:\n\n```sh\nmake linux-builder/setup\n```\n\nTo build a Linux AppImage using the resulting image, run the command:\n\n```sh\nmake linux-builder/release\n```\n\n### Hooks\n\nIt is highly recommended to install git hooks in the project repository. They make it easier to follow code Style. To install them, run the command:\n\n```sh\nmake setup-qa\nmake hook\n```\n\n## Trademarks\n\nNuPhy® is a registered trademark of NuPhy Studio. Nuga is an unofficial product and is not affiliated with NuPhy Studio.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmishamyrt%2Fnuga-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmishamyrt%2Fnuga-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmishamyrt%2Fnuga-app/lists"}