https://github.com/nerimity/nerimity-desktop
Electron desktop app for Nerimity
https://github.com/nerimity/nerimity-desktop
electron electronjs realtime socket-io solid-js solidjs
Last synced: 9 days ago
JSON representation
Electron desktop app for Nerimity
- Host: GitHub
- URL: https://github.com/nerimity/nerimity-desktop
- Owner: Nerimity
- Created: 2023-06-24T18:53:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-08T17:53:27.000Z (15 days ago)
- Last Synced: 2026-02-08T23:31:39.560Z (15 days ago)
- Topics: electron, electronjs, realtime, socket-io, solid-js, solidjs
- Language: JavaScript
- Homepage: https://nerimity.com
- Size: 790 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nerimity Desktop
### Download Nerimity
[Click here](https://github.com/Nerimity/nerimity-desktop/releases/latest) to download the latest releasae.
### Building
#### Prerequisites
- Node.js (v16 or higher)
- npm (comes with Node.js)
#### Installation
```bash
npm install
```
#### Building Installers
To build the installer for your current platform:
```bash
npm run app:dist
```
The built installer will be created in the `dist/` folder.
**Platform-specific builds:**
- **Windows**: Creates an NSIS installer (`.exe`)
- **macOS**: Creates a DMG installer (`.dmg`) - requires macOS to build
- **Linux**: Creates both `.deb` and `.AppImage` packages
To build for a specific platform:
```bash
npm run app:dist -- --win # Windows
npm run app:dist -- --mac # macOS
npm run app:dist -- --linux # Linux
```
### Releasing
When you want to create a new release, follow these steps:
1. Update the version in your project's `package.json` file (e.g. `2.0.0`)
2. Commit that change (`git commit -am v2.0.2`)
3. Tag your commit (`git tag v2.0.2`).
4. Push your changes to GitHub (`git push && git push --tags`)
After building successfully, the action will publish your release artifacts. By default, a new release draft will be created on GitHub with download links for your app. If you want to change this behavior, have a look at the [`electron-builder` docs](https://www.electron.build).
https://github.com/samuelmeuli/action-electron-builder