Getting Started

This guide will walk you through setting up your development environment, building, and running the Trufos application.

Prerequisites

Node.js: Use version v24 as specified in the .nvmrc file. It’s recommended to use a Node version manager like nvm to manage Node.js versions.
```
nvm use 24
```
Yarn: Yarn is already included as a dependency in the project, you don’t need to install it

Installation

Clone the Repository:

git clone https://github.com/EXXETA/trufos.git
cd trufos

Install Dependencies: Using Yarn, install all project dependencies:
```
yarn install
```

Running in Development Mode

To start the application in development mode with hot reloading and access to developer tools:

yarn start

This command utilizes electron-forge start and will open the application window. Changes in the src/main or src/renderer directories will typically trigger a reload.

Building the Application

To build a distributable version of the application for your current platform:

Ensure Dependencies are Installed: If you haven’t already, run:
```
yarn install
```
Run the Build Command:
```
yarn run make
```
This command uses electron-forge make to package the application.
Locate the Build Output: The built application will be located in the out/make directory. The specific file format depends on your operating system:
- Windows: A Setup.exe file (Squirrel installer).
- macOS: A .dmg file.
- Linux: A .zip file (currently; .deb is planned).

Testing

To run the test suite (using Vitest):

yarn test

This will execute tests for both the main and renderer processes.

Code Formatting and Linting

The project uses Prettier for code formatting and ESLint for linting.

Check Formatting:
```
yarn prettier-check
```
Apply Formatting:
```
yarn prettier
```
Run Linter:
```
yarn lint
```

Refer to the Coding Style guide for more details on setting up your IDE for automatic formatting.