https://github.com/chevp/quantum-rift-electron-client
Typescript Electron Client-App for Quantum Rift.
https://github.com/chevp/quantum-rift-electron-client
angular electron grpc javascript typescript vulkan-api
Last synced: 2 months ago
JSON representation
Typescript Electron Client-App for Quantum Rift.
- Host: GitHub
- URL: https://github.com/chevp/quantum-rift-electron-client
- Owner: chevp
- License: mit
- Created: 2024-06-30T17:23:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T20:40:12.000Z (over 1 year ago)
- Last Synced: 2025-06-30T23:06:21.501Z (12 months ago)
- Topics: angular, electron, grpc, javascript, typescript, vulkan-api
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quantum Rift Electron Client
This project is the **Electron** client application for **Quantum Rift**, built using **TypeScript**. The application provides a desktop client for interacting with the Quantum Rift system, offering a sleek user interface and seamless integration with the backend.
## Features
- **Cross-platform**: Runs on Windows, macOS, and Linux.
- **TypeScript Integration**: Strongly-typed client-side code for improved maintainability.
- **Electron Framework**: Combines the power of web technologies (HTML, CSS, JavaScript) with native desktop capabilities.
- **Real-time Communication**: Interacts with Quantum Rift backend services to provide up-to-date data.
- **Customizable UI**: Modify and extend UI components with ease.
## Requirements
- **Node.js** (>=14.x)
- **npm** (>=6.x)
- **Electron** (>=15.x)
## Setup
### 1. Clone the repository:
```bash
git clone https://github.com/chevp/quantum-rift-electron-client.git
cd quantum-rift-electron-client
```
### 2. Install dependencies:
```bash
npm install
```
### 3. Start the Electron app:
```bash
npm start
```
The app will start in a new Electron window. You can also build it for different platforms using Electron Packager.
## Building for Production
To package the app for distribution:
```bash
npm run build
```
### Packaging for Specific Platforms:
To package for **Windows**, **macOS**, or **Linux**, you can run:
```bash
npm run package:win # for Windows
npm run package:mac # for macOS
npm run package:linux # for Linux
```
## Folder Structure
```
├── src/ # Source code
│ ├── main/ # Main Electron process
│ ├── renderer/ # Renderer (UI) process
├── dist/ # Compiled output for production
├── package.json # npm scripts and dependencies
├── tsconfig.json # TypeScript configuration
├── webpack.config.js # Webpack configuration for bundling
└── README.md # This README file
```
## Development
To enable hot reloading and faster development, you can run:
```bash
npm run dev
```
This command will start the app in development mode with live-reloading enabled, so you can test changes without restarting the app.
## License
This project is licensed under the MIT License.