Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.58 KB

BUILD.md

File metadata and controls

40 lines (29 loc) · 1.58 KB

An Alphabet − Desktop | Build

An Alphabet is easy to build because it's a Node.JS/ElectronJS application.

Install dependencies

This project use some dependencies like marked for the lexing of the alphabets data, fs for get the content of the alphabets data, electron for the application and electron-builder for build the application.

To install them, you can try this:

npm install # Will install `marked`, `fs`, `electron` and `electron-builder`.

Testing

Now, you can test if the project work (With your edits. Normaly the project on GitHub work).

For test the project, you can run this command (enable DevTools in main.js if you need):

npm start # This will take few seconds to launch the application.

Building

In this last part, you will know how to build the project using eletron-builder.

You can try one of these four commands:

npm run build       # This will build for all platforms (Mac propably make an error, but don't worry it's normal)
npm run build-linux # Build for Linux
npm run build-win   # Build for Windows
npm run build-mac   # Build for macOS

Now, you can check in the /dist directory, and you will see these interesting files:

  • An Alphabet − Desktop-1.0.0.deb, the deb. installer for Linux
  • An Alphabet − Desktop-1.0.0.AppImage, the AppImage. installer for Linux
  • An Alphabet − Desktop-1.0.0.rpm, the rpm. installer for Linux
  • An Alphabet - Desktop Setup 1.0.0.exe, the .exe installer for Windows.
  • An Alphabet − Desktop-1.0.0.dmg, the dmg. installer for macOS