Giter Site home page Giter Site logo

hawkpass-desktop's Introduction

Build Status

A simple cross-platform cryptographically secure random number generator that uses entropy collected by your mouse movements to generate easy to remember passwords based on the Diceware list.

Hawkpass Desktop is the desktop version of the web app Hawkpass, and it is built on Electron.

Download

The latest version of Hawkpass can be downloaded from the releases page.

Testing locally

First install the necessary dependencies by running:

$ bower install

If you don't have bower installed run the following:

$ sudo npm install -g bower

Then to run the app locally you'll also need to install electron-prebuilt using npm.

Install electron-prebuilt globally:

$ sudo npm install electron-prebuilt -g

or locally:

$ npm install electron-prebuilt

Once electron-prebuilt is installed you will only need to run the following in the app's source directory:

// If you installed it globally
$ electron .
// If you installed it locally
$ ./node_modules/.bin/electron .
// or run
$ npm start

Packaging Hawkpass

Packaging Hawkpass for your platform can be done using electron-packager.

Type the following to install electron-packager

$ npm install --save-dev electron-packager

Generally the command to package an application is:

$ electron-packager <location> <name> <platform> <architecture> <version> <options>
<> Description
location location of your project
name name of your project
platform for which platform you want to build. Use --all to build for Windows, Mac and Linux
architecture for which architecture you want to build. --x86, --x64, --all for both
version which electron version to use --version
options output location --out, icon --icon

An example would be:

$ electron-packager ~/Projects/hawkpass-desktop Hawkpass --all --version=0.36.8 --out=~/Projects --icon=~/Project/icon.icns

To simplify the process we can create the following script inside package.json

"scripts": {
  "start": "electron .",
  "package": "electron-packager ./ Hawkpass --all --out ~/Projects/Hawkpass --version 0.36.8 --overwrite"
}

and then run the command below to start packaging:

$ npm run-script package

Contributing

Contributions are welcome! To get started please read the contribution guidelines.

Report any issues or feature requests you have here.

Licence

MIT

hawkpass-desktop's People

Contributors

kalpetros avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.