Impact Electron

Impact Electron is a cross-platform desktop application built using Electron.js. It supports Windows, macOS, and Linux platforms with streamlined development, building, and distribution workflows.

---

Table of Contents

• Installation
• Usage
• Development
• Build and Distribution
• License
• Author

---

Installation

Prerequisites

• Node.js installed on your machine.
• npm (comes with Node.js).

Steps to Install

1. Clone the Repository:

   git clone https://github.com/kararAcode/Impact-Electron.git
   cd Impact-Electron

2. Install Dependencies:

   npm install

3. Run the Application:

   npm start

---

Usage

To run the application in development mode:

npm start

---

Development

File Structure

• src/: Contains the source code of the application.
• resources/: Contains build resources like icons.
• build/: Output directory for built application files.

Scripts

• npm start: Runs the application in development mode.
• npm run build: Builds the application for all platforms.
• npm run build-mac: Builds the application for macOS.
• npm run build-win: Builds the application for Windows.

---

Build and Distribution

Build Requirements

• Windows: Install Windows Build Tools.
• macOS: Xcode Command Line Tools are required.
• Linux: Ensure required dependencies for AppImage, deb, and rpm are installed.

Building the App

To build the application for your platform:

npm run build

For platform-specific builds:

npm run build-mac    # macOS
npm run build-win    # Windows

Distribution

The application uses electron-builder for packaging and electron-updater for publishing updates. Releases are uploaded to the GitHub repository.

---

License

This project is licensed under the ISC License. See the LICENSE file for details.

---

Author

KararAcode

• GitHub Profile
• Email: alkarar975@gmail.com