# Hamsket
#### Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.
[![GNU GPL v3][license]](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Gitter][gitter]](https://gitter.im/TheGoddessInari/hamsket)
[![Release][release]](https://github.com/TheGoddessInari/hamsket/releases/latest)
[![Nightly][nightly]](https://github.com/TheGoddessInari/hamsket/releases/tag/nightly)
[![DevOps Build][devops-build]](https://dev.azure.com/TheGoddessInari/hamsket/_build?definitionId=2)
[![DevOps Deployment][devops-deploy]](https://dev.azure.com/TheGoddessInari/hamsket/_release?definitionId=1)
[![Dependencies][dependencies]](https://david-dm.org/TheGoddessInari/hamsket)
[![DevDependencies][dev-dependencies]](https://david-dm.org/TheGoddessInari/hamsket?type=dev)
[license]: https://img.shields.io/github/license/TheGoddessInari/hamsket.svg
[gitter]: https://img.shields.io/gitter/room/TheGoddessInari/hamsket.svg
[release]: https://img.shields.io/github/release/TheGoddessInari/hamsket.svg
[nightly]: https://img.shields.io/badge/Nightly-tag-red
[devops-build]: https://img.shields.io/azure-devops/build/TheGoddessInari/f5a88978-10c7-4069-97e0-59b9fc6d36a0/2.svg?logo=azure-devops
[devops-deploy]: https://img.shields.io/azure-devops/release/TheGoddessInari/f5a88978-10c7-4069-97e0-59b9fc6d36a0/1/1.svg?logo=azure-devops
[dependencies]: https://img.shields.io/david/TheGoddessInari/hamsket.svg
[dev-dependencies]: https://img.shields.io/david/dev/TheGoddessInari/hamsket.svg
##### Nightly build artifacts are available in Windows ([Win64](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket.Setup.0.6.1.exe)), Mac ([DMG](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket-0.6.1.dmg) / [App](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket-0.6.1-mac.zip)), and Linux ([AppImage64](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket-0.6.1.AppImage) / [RPM64](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket-0.6.1.x86_64.rpm) / [DEB64](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket_0.6.1_amd64.deb) / [Tarball64](https://github.com/TheGoddessInari/hamsket/releases/download/nightly/Hamsket-0.6.1.tar.gz)) packaging flavors.
###### Logo designed by [Andriy Yurchenko](http://andyur.com/).
###### Original Rambox by [Ramiro Saenz](https://github.com/saenzramiro).
----------
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Screenshot](#screenshot)
- [Services available - 94](#services-available---94)
- [Features](#features)
- [Privacy](#privacy)
- [Donations](#donations)
- [Compiling](#compiling)
- [Contributing](#contributing)
- [Quickstart](#quickstart)
- [Disclosure](#disclosure)
- [License](#license)
----------
## Screenshot
----------
## Services available - 94
----------
## Features
- [ ] Multi-language.
- [ ] Sync your configuration between multiple computers.
- [x] Master Password.
- [x] Lock Hamsket if you will be away for a period of time.
- [x] Don't disturb mode.
- [x] Reorder applications in the tab bar.
- [x] Notification badge in the tab.
- [x] Minimize to tray.
- [x] Mute audio to specific service.
- [x] Separate tabs floating to the right.
- [x] Disable a service instead of remove it.
- [x] Start automatically on system startup.
- [x] Custom Javascript injection.
- [x] Custom CSS injection.
- [x] Keyboard Shortcuts.
- [x] Proxy.
- [x] Passive mouse/touch event listeners by default.
- [x] Lowered timer granularity to save CPU time by default.
- [x] No user tracking.
- [x] Fully open source, won't change
- [x] Highly responsive to issues, PRs, and help.
- [x] Offline backup and restore.
----------
## Privacy
No personal information will be saved or tracked.
Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. So every time you open Hamsket, your sessions will keep alive until you remove the service.
~~Sync feature use [Auth0](https://auth0.com/) for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). You are always welcome to check the code! ;)~~
Auth0 is disabled pending name change and rewrite of the functionality to best preserve your security and functionality.
----------
## Donations
Keep in mind, I'm not pushing this. I'll do my best regardless.
| Type | URL/Wallet |
| ------------ | :----------------------------------------------: |
| GoFundMe | |
----------
## Compiling
To build your own copy, you need:
- An 8.0 version of the [Java SE Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
- [Ruby](https://www.ruby-lang.org/en/downloads/) 2.3 or newer.
- [Sencha CMD](https://www.sencha.com/products/extjs/cmd-download/) 6.7.0 or newer, and to install it with the Compass extension.
- [NodeJS](https://nodejs.org/en/download/) 8.5.0 (10.0+ preferred) or newer with npm.
These **need** to be added to your PATH.
```shell
git clone https://github.com/TheGoddessInari/hamsket.git
cd hamsket
npm install
npm run repack:win64
```
You can substitute win64 for linux32, linux64, win32, or osx as desired. This will create an unpacked directory in '**dist**' for testing.
```shell
npm run setup
```
This step instead of **repack** will create an installer appropriate to your platform in '**dist**'.
You can place unpacked files over where the installers normally place their files for development/testing purposes.
**NOTE:** 32-bit builds are **deprecated** by electron-builder and are likely to be removed at some point in the future.
----------
## [Contributing](./CONTRIBUTING.md)
Want to report a bug, request a feature, contribute to or translate Hamsket? We need all the help we can get! Fork and work!
----------
## Quickstart
```shell
git clone https://github.com/TheGoddessInari/hamsket.git
cd hamsket
npm install
npm start
```
See [Contributing.md](./CONTRIBUTING.md) for more detailed information about getting set up.
----------
## Disclosure
Hamsket is not affiliated with any of the messaging apps offered.
----------
## License
[GNU GPL v3](./LICENSE)
----------