Git Product home page Git Product logo

qvault's Introduction

Qvault (qvault.io)

An open source, Bitcoin friendly, and extremely secure password manager

Build Status Github All Releases Known Vulnerabilities

๐Ÿ’ฌ Contact Qvault

Twitter Follow Discord Chat Medium

๐ŸŒŸ Features

  • Open source - as all password managers should be
  • Generate Bitcoin cold wallets from within the app
  • Offline mode - optional
  • Dual encryption using Qr Codes - optional
  • Recovery code in case master password is forgotten - optional
  • Simple - all encrypted vaults are stored locally in .qvault files
  • Free cloud backup storage - optional
  • Virtual keyboard to bypass keylogger malware
  • Import passwords from a CSV (most browsers can export to CSV)
  • Windows, Mac and Linux
  • All windows and mac releases are code signed and updates are optional (prompted) within the app

cryptocurrency bitcoin password manager

โš™๏ธ Compatibility

Pre-built one-click releases can be found on our releases page. We officially support:

  • Windows - .exe NSIS installer
  • Mac OS - .dmg installer
  • Linux - .AppImage

We also want to give a special thanks to XDaemonX for maintaining the Arch Linux (AUR) package which can be found at: https://aur.archlinux.org/packages/qvault/

Some linux distros don't support unprivileged CLONE_NEWUSER, without that, the electron sandbox won't work. Since security is our #1 priority, we will not be disabling the sandbox; however, if you wish to run Qvault on an unsupported distro, you can use the --no-sandbox flag.

๐Ÿ‘ Contributing

We love help! Contribute by forking the repo and opening pull requests. Please ensure that your code passes the existing tests, and write tests to test your changes if applicable.

All pull requests should be submitted to the "master" branch. Code in the "prod" branch is live in the latest release.

Quickstart

Clone and enter the repo

git clone https://github.com/q-vault/qvault
cd qvault

Install dependencies

We use yarn as opposed to npm due it being recommended by most electron tools.

yarn install

Run development application

yarn dev

โ˜๏ธ Cloud Server

Users can choose to optionally store their encrypted vault on Qvault's servers. The API that Qvault uses is hosted at https://api.qvault.io

The only version of Qvault at any moment that is guaranteed to work nicely with the cloud server is the latest release, although we do our best to maintain backwards compatibility. Please update accordingly.

In the future we plan to open source the server code and allow users to change their host address within the app.

Linting and Styling

Qvault uses eslint and all pull requests must pass the eslint tests. Make sure your code adheres to the rules defined in .eslintrc.json

To run the linting tests:

yarn lint

To try to autofix the repo:

yarn lint-fix

Some general rules that Qvault follows additionaly:

  • All javascript filenames, functions, and variables are camelCase
  • All vue filenames and components are PascalCase

Node Version - NVM

NVM, or node version manager, is used to keep track of the supported node version. If you are having strange node api errors, be sure to set the correct node version:

nvm use

๐Ÿงช Run Tests

Mocha Chai

yarn test

๐Ÿ”จ Build from source

Building from source is the best way to ensure code integrity, but keep in mind auto-updates will not work.

yarn release --publish never

Helpful VSCode settings

These are the repo-level settings some of us use in vscode. We also recommend using the eslint plugin by Dirk Baeumer.

{
    "editor.formatOnSave": false,
    "files.eol": "\n",
    "eslint.validate": [
        {
            "language": "vue",
            "autoFix": true
        },
        {
            "language": "javascript",
            "autoFix": true
        }
    ],
    "eslint.autoFixOnSave": true
}

๐Ÿ—จ๏ธ Contact the Devs

The best way to get in contact with the developers is on the public discord server.

Discord Chat

Also follow Lane or contact him on twitter or medium

Medium - Lane Twitter Follow

qvault's People

Contributors

aldaircruz avatar appins avatar auchenberg avatar bhaveshgohel avatar bratsos avatar chankruze avatar ckerr avatar clemens-tolboom avatar codebytere avatar falkendk avatar galeksandrp avatar haacked avatar hum4n01d avatar icodeforbananas avatar ionicabizau avatar izuzak avatar jlord avatar kevinsawicki avatar louis993546 avatar maddhruv avatar phanect avatar posva avatar preston-wagner avatar sahildua2305 avatar sebastianschmidt avatar shiftkey avatar tcyrus avatar thompsonemerson avatar wagslane avatar zeke 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.