pearpass-app-desktop

PearPass is a distributed password manager powered by Pear Runtime. It allows secure storage of passwords, credit card details, and secure notes, with the ability to distribute data across multiple devices.

Table of Contents

• Features
• Installation
• Testing
• Usage Examples
• Dependencies
• Related Projects

Features

• Secure password, identity, and credit card, notes and custom fields storage
• Cross-device and platform synchronization
• Offline access to your credentials
• Encryption for data security
• Password strength analysis
• Random password generator
• Easy-to-use interface

Installation

• Node.js: Ensure you have the correct Node.js version installed. You can check the required version in the .nvmrc file. And ensure it matches to your current node version by running:

node --version

• Pear: Ensure you have Pear installed mode details can be found here

Clone the repository

git clone git@github.com:tetherto/pearpass-app-desktop.git

Go to the cloned directory

cd pearpass-app-desktop

Install npm modules

npm install

generate translation keys

npm run build

run the app

npm run dev

Testing

Unit Testing

Run unit tests with Jest:

npm test

Staging to dev

Ensure the app runs correctly using npm run dev.

If successful, stage it—for example: pear stage dev.

Then run the app: pear run pear://GENERATED_URL.

Pear serves files from the "dist" folder:

<!-- index.html -->
<script type="module" src="./dist/app.js"></script>

The "src" folder is for development and it's ignored in package.json

  "ignore": [
    ".github",
    "appling",
    ".git",
    ".gitignore",
    "packages",
    "src"     
  ]

Depended modules

The following sibling modules must be present in the workspace (they are not declared as npm dependencies):

• @tetherto/tether-dev-docs
• @tetherto/pear-apps-lib-feedback
• @tetherto/pear-apps-lib-ui-react-hooks
• @tetherto/pear-apps-utils-avatar-initials
• @tetherto/pear-apps-utils-date
• @tetherto/pear-apps-utils-generate-unique-id
• @tetherto/pear-apps-utils-pattern-search
• @tetherto/pear-apps-utils-qr
• @tetherto/pear-apps-utils-validator
• @tetherto/pearpass-lib-constants
• @tetherto/pearpass-lib-data-export
• @tetherto/pearpass-lib-data-import
• @tetherto/pearpass-lib-ui-theme-provider
• @tetherto/pearpass-lib-vault
• @tetherto/pearpass-lib-vault-core
• @tetherto/pearpass-utils-password-check
• @tetherto/pearpass-utils-password-generator

Dependencies

• Pear Runtime
• React
• Styled Components
• Lingui
• Redux

Related Projects

• @tetherto/pearpass-app-mobile - A mobile app for PearPass, a password manager
• @tetherto/pearpass-lib-ui-react-native-components - A library of React Native UI components for PearPass
• @tetherto/pearpass-lib-ui-react-components - A library of React UI components for PearPass
• @tetherto/pearpass-app-browser-extension - A browser extension for PearPass, a password manager
• @tetherto/tether-dev-docs - Documentations and guides for developers
• @tetherto/pearpass-lib-vault - A library for managing password vaults
• @tetherto/pearpass-lib-vault-core - A bare worker and a client for PearPass vaults

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE file for details.