AccessFlair (Linux)

AccessFlair is a generic screen mirroring and remote control application for Linux.

Prerequisites

Before installing, ensure you have the following system dependencies installed (required for robotjs and other native modules):

sudo apt-get update
sudo apt-get install build-essential libxtst-dev libpng++-dev

You also need Node.js (version 12 or higher) and npm.

Installation

1. Clone the repository (if you haven't already).

2. Install the project dependencies:

   npm install

   Note: The application uses a pre-compiled native binary (screen-capture-node.linux-x64-gnu.node) for screen capturing. Ensure this file is present in the root directory.

Development

To run the application in development mode:

npm run dev

This will start the Electron application with NODE_ENV=development.

Build

To build the application for production, you can use the following commands:

Build All Targets

npm run build

This command uses electron-builder to package the application based on the configuration in package.json.

Build AppImage

npm run build:appimage

Creates an .AppImage file in the dist directory.

Build Flatpak

npm run build:flatpak

Creates a Flatpak bundle.

Project Structure

• main.js: The main entry point for the Electron application.
• index.js: Handles the native screen capture binding.
• index.html: The main frontend entry point.
• assets/: Contains application assets like icons.
• screen-capture-node.linux-x64-gnu.node: Pre-compiled native binary for screen capturing.

License

MIT