{"id":18771107,"url":"https://github.com/bigasdev/haxe-electron-learning","last_synced_at":"2026-02-25T08:40:29.068Z","repository":{"id":111483884,"uuid":"497979368","full_name":"bigasdev/haxe-electron-learning","owner":"bigasdev","description":"learning how to use haxe-electron","archived":false,"fork":false,"pushed_at":"2022-05-30T14:33:57.000Z","size":858,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-29T07:43:28.641Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Haxe","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/bigasdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-30T14:33:56.000Z","updated_at":"2022-05-30T14:34:00.000Z","dependencies_parsed_at":"2023-04-26T08:34:47.025Z","dependency_job_id":null,"html_url":"https://github.com/bigasdev/haxe-electron-learning","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"deepnight/electronBase","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigasdev%2Fhaxe-electron-learning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigasdev%2Fhaxe-electron-learning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigasdev%2Fhaxe-electron-learning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigasdev%2Fhaxe-electron-learning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigasdev","download_url":"https://codeload.github.com/bigasdev/haxe-electron-learning/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239678115,"owners_count":19679202,"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-07T19:23:15.586Z","updated_at":"2025-12-12T04:30:15.769Z","avatar_url":"https://github.com/bigasdev.png","language":"Haxe","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron app base for Haxe\n\n## About\n\n**This project is the minimal structure to easily build an [Electron](https://www.electronjs.org/) based app using [Haxe](https://haxe.org) language.**\n\n## Features\n - [Haxe](https://haxe.org) + [Heaps](https://heaps.io) engine to render 2D/3D in a WebGL canvas\n - jQuery for all DOM manipulations (you can use something else if you prefer)\n - Electron auto-updater (using Git releases)\n\n# Installing\n\n## Requirements\n\nYou will need:\n - [Haxe](https://haxe.org) compiler,\n - [NPM](https://www.npmjs.com/) to install dependencies,\n - My libs `deepnightLibs` for Haxe (see below),\n - [VScode](https://code.visualstudio.com/) is recommended.\n\n\n## Installing Haxe\n\nPlease refer to this tutorial to install Haxe: [Quick guide to install Haxe](https://deepnight.net/tutorial/a-quick-guide-to-installing-haxe/).\n\n## Getting \"deepnightLibs\"\n\nRun the following command to install my `deepnightLibs`:\n```\nhaxelib git deepnightLibs https://github.com/deepnight/deepnightLibs.git\n```\n\n## Getting the source code\n\n### Method 1: fork\n\nNothing special here, you probably know the drill.\n\n### Method 2: using GitHub template\n\nJust go to the [ElectronBase repository](https://github.com/deepnight/electronBase) on GitHub and click on the \"**Use this template**\" button.\n\nLearn more about [GitHub templates here](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).\n\n### Method 3: adding an upstream remote\n\nThis method is quite similar to a fork:\n\n 1. Make a new empty repo somewhere. It *must* be **strictly empty**: no LICENSE, no README, nothing.\n 2. Clone it on your system\n 3. Run:\n```\ngit remote add electronBase https://github.com/deepnight/electronBase.git\ngit pull electronBase master\ngit push origin master\n```\n\n## Installing Electron and dependencies\n\nAfter retrieving the source code, open a command line **in the root of the repo** and run:\n\n```\nnpm i\n```\n\n# Usage\n\n## Repo structure\n- `src/electron.main/`: Haxe source code for the Electron Main (ie. very first JS file to be ran on startup).\n- `src/electron.renderer/`: Haxe source code for the Electron Renderer (ie. the actual app browser window).\n- `src/bindinds/`: various extern bindings for Haxe (jQuery, electron auto-updater etc).\n- `electron/`: Electron related files (ie. application and redistributable assets)\n- `res/`: Heaps (webGL) resources, if any.\n\n## Compiling\n\nTo build the Electron main JS:\n```\nhaxe main.debug.hxml\n```\n\nTo build the Electron renderer JS:\n```\nhaxe renderer.debug.hxml\n```\n\nAlternatively, you can build non-debug files using:\n```\nhaxe main.hxml\nhaxe renderer.hxml\n```\nOr:\n```\nnpm run compile\n```\n\n## Running\n\nTo run the compiled app:\n```\nnpm start\n```\n**NOTE:** for some obscure reason, this last command might not work. You can still run the app by either:\n - using **VScode**, and executing `Start debugging` command.\n - run `npm run pack-test` to quickly create an unpacked redistributable, then execute the `.exe` file in the `/electron/redist/win-unpacked` folder.\n\n## Creating redistributables\n\n**Windows**:\n```\nnpm run pack-win\n```\n\n**macOS** (requires an actual OSX environment):\n```\nnpm run pack-macos\n```\n\n**Linux**:\n```\nnpm run pack-linux-x86\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigasdev%2Fhaxe-electron-learning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigasdev%2Fhaxe-electron-learning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigasdev%2Fhaxe-electron-learning/lists"}