https://github.com/electron-userland/electron-installer-snap

Build Snap packages for Electron applications
https://github.com/electron-userland/electron-installer-snap

electron linux snap

Last synced: about 2 months ago
JSON representation

Build Snap packages for Electron applications

• Host: GitHub
• URL: https://github.com/electron-userland/electron-installer-snap
• Owner: electron-userland
• License: apache-2.0
• Created: 2017-09-25T21:29:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-09T03:20:27.000Z (over 1 year ago)
• Last Synced: 2024-12-17T08:47:39.086Z (about 2 months ago)
• Topics: electron, linux, snap
• Language: JavaScript
• Homepage:
• Size: 962 KB
• Stars: 50
• Watchers: 7
• Forks: 18
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Support: SUPPORT.md

Awesome Lists containing this project

README

        
# Electron Installer: Snap

[![Build Status](https://github.com/electron-userland/electron-installer-snap/workflows/CI/badge.svg)](https://github.com/electron-userland/electron-installer-snap/actions?query=workflow:CI)

[![Code Coverage](https://codecov.io/gh/electron-userland/electron-installer-snap/branch/master/graph/badge.svg)](https://codecov.io/gh/electron-userland/electron-installer-snap)

Builds Snap files for Electron applications that have already been bundled and customized.

## Requirements

Requires Node 10 or greater, and [`snapcraft`](https://snapcraft.io).

## Quick Start

The easiest way is to use [Electron Forge](https://electronforge.io) and enable the `snap` maker.

To use this as a standalone CLI, install `electron-installer-snap` to your project:

```shell

npm install --save-dev electron-installer-snap

# or

yarn add --dev electron-installer-snap

```

Then add to your `package.json`:

```javascript

{

  // ...

  "scripts": {

    "build:package": "electron-packager . --out=out"

    "build:snap": "electron-installer-snap --src=out/myappname-linux-x64"

  },

  // ...

}

```

Then you can run `npm run build:package && npm run build:snap`, which will prepare the Electron app

for bundling and generate a `.snap` file in your current directory.

It is recommended to ignore the generated `snap` directory in your version control.

## Options

Available command-line options are displayed when you run `electron-installer-snap --help`.

For the JavaScript API, please see the [API docs](https://electron-userland.github.io/electron-installer-snap/).

## Thanks

Thank you to Canonical for the support in getting this module created, during the September 2017

Ubuntu Rally and the January 2018 Snapcraft Summit.

## Legal

This project is copyrighted under the Apache License (version 2). See LICENSE for details.