Skip to content

Commit

Permalink
🎉 Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
aliceandbob-io committed Feb 6, 2021
0 parents commit 24ddf0e
Show file tree
Hide file tree
Showing 32 changed files with 65,153 additions and 0 deletions.
89 changes: 89 additions & 0 deletions .gitignore
@@ -0,0 +1,89 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock
.DS_Store

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# Webpack
.webpack/

# Electron-Forge
out/
77 changes: 77 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,77 @@

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at hello@aliceandbob.io. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
21 changes: 21 additions & 0 deletions LICENSE.md
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 aliceandbob.io

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
75 changes: 75 additions & 0 deletions README.md
@@ -0,0 +1,75 @@
# aliceandbob.io - Desktop app 🖥️🔐

A free, light and easy to use desktop app to generate PGP key pairs, encrypt and decrypt messages. The desktop app works fully offline to ensure maximum security to the user.

**⚡ Looking for the online PGP tool from aliceandbob.io instead? Go [here](https://aliceandbob.io/online-pgp-tool) or on its [GitHub's page](https://github.com/aliceandbob-io/aliceandbob).**

## Download it ⬇️

- From the repo's Github page: [releases](https://github.com/aliceandbob-io/aliceandbob-desktop/releases)
- From [aliceandbobio](https://aliceandbob.io/)

## Installation

⚠️ If you install the app on windows, you might get a warning from your anti-virus. It is because Windows builds are not signed. No worries, just add an exception for the app in your anti-virus software.

## Features ✨

- 🗝️ Generate PGP key pairs
- 🔒 Encrypt messages with the public PGP key of the receiver
- 🔓 Decrypt messages with your private PGP key

## Tech 🔧

- [Electron.js](https://www.electronjs.org/): Electron.js helps building cross-platform desktop apps with JavaScript, HTML, and CSS
- [Electron-forge](https://www.electronforge.io/): Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications
- HTML/CSS/Javascript
- [Stimulus JS (v2.0.0)](https://stimulus.hotwire.dev/): A modest JavaScript framework
- [Webpack](https://webpack.js.org/): The whole app is bundle with webpack through the electron-forge webpack plugin

## Library 📚

OpenPGP.js (v4.10.7), a JavaScript implementation of the OpenPGP protocol. Find out more on [openpgpjs.org](https://openpgpjs.org/).

## Contributing 🍰

Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Refer first to the open issues then create a branch, add commits, and open a pull request!

You can also read the [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md).

When forking and cloning the repo, don't forget to do the following:
1. Make sure to have `node`, `npm` and `yarn` installed on your machine
2. run `yarn install` from the cloned repo.
3. Then, `yarn start` to launch aliceandbob.io Desktop App in dev mode.

⚠️ If you get any errors and warnings, install the necessary apps, packages or updates your platform may require.

Find more info regarding the process and the configuration on the [electronforge.io](https://www.electronforge.io/) page.

## Building the desktop app locally 🏗️

If you want to package and build the app on your machine, run `yarn make --platform=<target build platform> --arch=<target arch>`.
As for the platform, you can choose either:
- `win32`,
- `linux`,
- `darwin`, or
- `mas`.

As for the arch, you can choose either:
- `x64`,
- `ia32`,
- `armv7l`,
- `arm64`, or
- `mips64el`.

See all available options on the [electronPackager page](https://electron.github.io/electron-packager/master/interfaces/electronpackager.options.html).

Note that some specific builds cannot be done from some platforms. Learn more [here](https://www.electronforge.io/config/makers).

## Want to support the app? ❤️

<a href="https://www.buymeacoffee.com/aliceandbobio" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="35"/></a>

## License 📄

Licensed under the [MIT License](LICENSE.md).
49 changes: 49 additions & 0 deletions forge.config.js
@@ -0,0 +1,49 @@
const path = require('path');

module.exports = {
packagerConfig: {
icon: path.resolve(__dirname, 'src/img/icon'),
executableName: "aliceandbob.io"
},
makers: [
{
name: "@electron-forge/maker-squirrel",
config: {
iconUrl: "https://raw.githubusercontent.com/aliceandbob-io/files/main/icon.ico",
setupIcon: path.resolve(__dirname, 'src/img/icon.ico')
}
},
{
name: "@electron-forge/maker-zip",
platforms: [
"darwin"
]
},
{
name: "@electron-forge/maker-deb",
config: {}
},
{
name: "@electron-forge/maker-rpm",
config: {}
}
],
plugins: [
[
"@electron-forge/plugin-webpack",
{
mainConfig: "./webpack.main.config.js",
renderer: {
config: "./webpack.renderer.config.js",
entryPoints: [
{
html: "./src/index.html",
js: "./src/renderer.js",
name: "main_window"
}
]
}
}
]
]
}

0 comments on commit 24ddf0e

Please sign in to comment.