Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 2.8 KB

README.md

File metadata and controls

64 lines (37 loc) · 2.8 KB
Raw

Silex Desktop

Silex desktop is the Electron application that serves all the frontend apps of the pipeline.

Introduction

In order to access the filesystem and other OS specific features that are hidden in the browser, we use Electron.

Electron is a chromium based browser and enables us to package the frontend applications of the pipeline into a single desktop app for users.

We also have silex-socket-service as a dependency so the socket server is started automatically on startup.

Installation

Prerequisites

Since the desktop application requires silex-socket-service as a dependency and it's part of the ArtFX organization, you need to do the following:

  • Create a .npmrc file in the root folder with that content:

    //npm.pkg.github.com/:_authToken=<YOUR_GITHUB_TOKEN>
@artfxdev:registry=https://npm.pkg.github.com/

  • Replace <YOUR_GITHUB_TOKEN> with your GitHub access token (see here for where to get it).

Install dependencies

The package manager used is Yarn. Clone the repository and install the dependencies:

$ git clone https://github.com/ArtFXDev/silex-desktop
$ cd silex-desktop
$ yarn install # Install the dependencies

Usage

Available scripts

  • 🚀 yarn start -> Opens an instance of the Electron app

Libraries

Here are the main libraries and packages used:

Library Version
Electron 13.5.2

Contributing

Pull requests and issues are welcome. For major changes, please open an issue first to discuss what you would like to change.

✨ This project uses the Conventional Commits convention for commit messages. They are checked automatically with a git hook (thanks to Husky and commitlint).

License

MIT @ArtFX