Skip to content

Commit 157d782

Browse files
authored
Update README to describe steps for manual building
1 parent d5e51b5 commit 157d782

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,29 @@ Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)
8787
<img src="Screenshots/Android.png" width="600"/>
8888
</div>
8989

90+
## Manual building
91+
92+
In case of issues with running the app on your version of OS, it's possible to easily build it yourself.
93+
94+
Steps:
95+
1) Download or clone the repository
96+
2) Install `node` on your computer (https://nodejs.org/en/)
97+
3) Run `npm install` in the root of downloaded/cloned project
98+
4) Verify that the app can be launched with the command `npm start` (optional)
99+
5) Build the project to generate installable files (2 options):
100+
101+
- For building with `electron-builder` you need to run `npm run dist`. Generated files end up in the folder `dist` in the root of your project.
102+
- For building with `electron-packager` you need to run `npm run release`. Generated files end up in the folder `PushNotifications-darwin-x64` in the root of your project (macOS only).
103+
104+
To build for Windows & Linux you need to use `electron-builder`. Also, this way is preferable because it creates installable files.
105+
106+
`electron-builder` will generate:
107+
- For macOS: `.zip`, `.dmg` (if you build using macOS)
108+
- For Windows: `.msi` (if you build using Windows)
109+
- For Linux: `.deb`, `.AppImage` (if you build using Linux)
110+
111+
Keep in mind: you cannot build for Windows or Linux, if you are using macOS, or vise versa. It creates installable files only for your current OS.
112+
90113
## Credit
91114

92115
- Icon http://emojione.com/

0 commit comments

Comments
 (0)