Tobii Tile is an Electron-based application designed to provide an accessible graphical user interface. This README provides instructions on how to set up, run, test, and build the application.

• Tobii Tile
  • Table of Contents
  • Prerequisites
  • Installation
  • Running in Development Mode
  • Testing
  • Building the Electron App
    • Packaging the Application
    • Distributing the Application
  • Usage
    • Development Mode
    • Zoom Controls

Before you begin, ensure you have the following installed:

• Node.js (v14 or later): Download Node.js
• npm (comes with Node.js)

1. Clone the Repository

   git clone https://github.com/A-T-O-M-I-X/TobiiTile.git
   cd TobiiTile

2. Install Dependencies

   Install the necessary dependencies using npm:

   npm install

To run the application in development mode:

npm run start

This command will launch the Electron application. Any changes you make to the source files will require restarting the application.

Currently, there are no automated tests set up for this project. To add tests, consider integrating a testing framework like Jest or Mocha.

To package the Electron application for Linux using Electron Packager:

npm run package

This command uses Electron Packager to package the app. The output will be in a directory named TobiiTile-linux-x64 within your project folder.

For more advanced packaging and distribution using Electron Builder:

1. Build with Electron Builder

   npm run dist

   This command uses Electron Builder to create a distributable AppImage in the dist folder.

2. Locate the Built Application

   After running the above command, find the AppImage in the dist directory:

   cd dist

3. Run the AppImage

   Make the AppImage executable and run it:

   chmod  x AccessibleGUI-*.AppImage
   ./TobiiTile-*.AppImage

• Start the App:

  npm run start

• Code Structure:

  • Main Process: main.js
  • Renderer Process: Located in the src directory.
  • Preload Scripts: preload.js

The application includes zoom controls integrated into the top bar, allowing you to adjust the browser's native zoom level.

• Increase Zoom: Click the button.
• Decrease Zoom: Click the - button.
• Current Zoom Level: Displayed between the zoom buttons.

Note: Adjusting the zoom level may affect the layout. Ensure responsive design practices are followed to maintain usability.