Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kryptokrona/hugin-desktop
A secure and private messaging desktop application.
https://github.com/kryptokrona/hugin-desktop
blockchain cryptocurrency electron hugin hypercore-protocol javascript kryptokrona p2p svelte web3 webrtc
Last synced: 3 months ago
JSON representation
A secure and private messaging desktop application.
- Host: GitHub
- URL: https://github.com/kryptokrona/hugin-desktop
- Owner: kryptokrona
- License: gpl-3.0
- Created: 2022-03-26T14:38:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T12:21:30.000Z (9 months ago)
- Last Synced: 2024-04-23T20:41:54.389Z (9 months ago)
- Topics: blockchain, cryptocurrency, electron, hugin, hypercore-protocol, javascript, kryptokrona, p2p, svelte, web3, webrtc
- Language: Svelte
- Homepage: https://hugin.chat
- Size: 9.53 MB
- Stars: 36
- Watchers: 5
- Forks: 12
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-web3 - Hugin Messenger - Desktop - Private messaging application on Kryptokrona Blockchain for desktop. (Open Source Project / Risk Management)
README
Hugin is a messaging service where messages are relayed by Kryptokrona nodes. Your messages are secured with industry leading encryption so that only you and your chat partner have the possibility to read them. **The purpose** is **not** to gather any personal information about the users, unlike most apps and social media.
Hugin also packs some powerful decentralized P2P encrypted features like **video, voice**, **screen sharing** and **filesharing**. This is possible because we've managed to compress the requests to establish a connection (called SDP) with WebRTC from over 2000 characters to less than 200 – which means that a connection through Hugin is possible!
# Table of Contents
- [Table of Contents](#table-of-contents)
- [Development Resources](#development-resources)
- [Technologies](#technologies)
- [Getting Started](#getting-started)
- [Build](#build)
- [CI/CD](#cicd)
- [Contribute](#contribute)
- [Pull Request](#pull-request)
- [Contributors](#contributors)
- [License](#license)
# Development Resources
- Web: https://hugin.chat
- GitHub: https://github.com/kryptokrona
- Hugin: hugin group on `20b4821b90b2ea7355cb7ed7fa60823016eedef0e3541376888f8adc55df75f8`
- It is HIGHLY recommended to join our group on Hugin Messenger if you want to contribute to stay up to date on what is happening on the project.
# Technologies
- Node 16 (16.16.0 currently)
- Electron
- Svelte
- WebRTC
- Hypercore Protocol
# Getting Started
> \*Feel free to substitute `npm` with `pnpm` or `yarn`.
| | |
| ------- | ----------------- |
| Install | · `npm install` |
| Develop | · `npm run dev` |
## Build
To build a target we have the following options:
| | |
|--------------------------|-----------------------------|
| macOS Apple Silicon (M1) | · `npm run build:mac-arm64` |
| macOS Intel (x64) | · `npm run build:mac-x64` |
| Windows | · `npm run build` |
| Linux | · `npm run build:linux-x64` |
# CI/CD
This project is automatically built, tested and deployed using GitHub Actions. We have two pipelines:
- **Main Pipeline** - This is the pipeline that runs the code merged into our main branch.
- **Pull Request Pipeline** - This is the pipeline that runs each time a pull request come in so the reviewer has some help evaluating if the code is good enough to be merged.
The Main Pipeline do everything the Pull Request Pipeline does in addition to building and publishing artifacts of different architectures and OS.
# Contribute
## Pull Request
We appreciate all contributions whether it be small changes such as documentation of source code to major improvement of code. The easiest way is to make a fork and then make a pull request into our main branch. To make the PR go through make sure to include this information:
```
What does this PR do?
Why are these changes required?
This PR has been tested using (e.g. Unit Tests, Manual Testing):
Extra details?
```
A pull request is approved if the GitHub Actions pipeline is marked green. Otherwise it will be closed directly. Always make sure to run the unit tests before creating a pull request.
# Contributors
The following contributors have either helped to start this project, have contributed
code, are actively maintaining it (including documentation), or in other ways
being awesome contributors to this project. **We'd like to take a moment to recognize them.**
[
](https://github.com/n9lsjr)
[
](https://github.com/Swepool)
[
](https://github.com/mjovanc)
[
](https://github.com/f-r00t)
[
](https://github.com/appelskrutt34)
[
](https://github.com/TechyGuy17)
# License
The license is GPL-3.0 License.