diff --git a/README.md b/README.md index 70d4aea60..c61719353 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,36 @@ $ sudo snap install iptvnator [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/iptvnator) +Buy Me A Coffee + +## How to build + +Requirements: node.js with npm. + +1. Clone this repository and install all project dependencies with: + ``` + $ npm install + ``` + +2. To build the application on your local machine use one of the following commands: + ``` + # linux + $ npm run electron:build:linux + ``` + + ``` + #mac + $ npm run electron:build:mac + ``` + + ``` + # windows + $ npm run electron:build:windows + ``` + +This command will produce the distributable assets in the `release` folder based on the configuration from electron-builder which is stored in `electron-builder.json` and `package.json`. Check the [API description of electron-builder](https://www.electron.build/) and adapt the configuration if you need some special configuration for you environment. + +*Note: Don’t expect that you can build app for all platforms on one platform. [Read details](https://www.electron.build/multi-platform-build)* ## Disclaimer diff --git a/package.json b/package.json index d0f0d76ee..be0d69ae3 100644 --- a/package.json +++ b/package.json @@ -33,6 +33,9 @@ "electron:serve": "wait-on tcp:4200 && npm run electron:serve-tsc && npx electron . --serve", "electron:local": "npm run build:prod && npx electron .", "electron:build": "npm run build:prod && electron-builder build", + "electron:build:mac": "npm run build:prod && electron-builder build -m", + "electron:build:linux": "npm run build:prod && electron-builder build -l --x64 --ia32 --arm64 --armv7l", + "electron:build:windows": "npm run build:prod && electron-builder build -w", "test": "jest", "test:watch": "jest --watch", "e2e": "npm run build:prod && cross-env TS_NODE_PROJECT='e2e/tsconfig.e2e.json' mocha e2e/**/*.ts --config ./.mocharc.json --exit",