ZeroPass Client
ZeroPass is more than a Password Protection and Management tool, it secures all your valuable digital assets in your own vault, including the personal vault and the company vault
1. Prerequisites
This project is the client part of ZeroPass, it needs to work with the server part on a live system. You can deploy your own ZeroPass Server or use our official deployments(https://api.zpassapp.com/) directly, the endpoint will be used as the parameter "ZeroPass Server URL" in the following steps.
The instructions in Local development setup will get you a copy of the project up and running on your local machine for development and testing purposes. See Build for steps on how to build the project to a desktop app.
Verify your development environment has the minimum prerequisite versions of Node and Yarn installed:
- node >=16 LTS (32-bit)
- yarn >=1.22.0
Node 64-bit is currently not supported.
2. Local development setup
2.1 Install dependencies
Under the root directory, run the following to install the dependencies.
yarn
cd render && yarn
2.2 Run render process
Under the root directory, run the following commands to start the render process.
ZeroPass Server URL: ZeroPass Server Deployment URL (e.g. https://ZeroPassServer)
cd render
npm start --PROXY_URL=[ZeroPass Server URL]
2.3 Run main process
Under the root directory, run the following to start the main process.
npm run electron
3. Build
3.1 Install dependencies
Under the root directory, run the following to install the dependencies.
yarn
cd render && yarn
3.2 Build project
Under the root directory, run the following to build the project. ZeroPass Client update URL is used for auto upgrade, it's optional.
ZeroPass Server URL: ZeroPass Server Deployment URL (e.g. https://ZeroPassServer)
ZeroPass Client update URL(optional): ZeroPass Client Deployment URL (e.g. https://ZeroPassClientUpdateServer)
npm run electron-win:build --BASE_URL=[ZeroPass Server URL] --UPDATE_URL=[ZeroPass Client update URL]
You can find the app ZeroPass-Community-x.x.x.exe under the build directory.
4. Contributing
Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on the contributing and our code of conduct.
5. Versioning
For the versions available, see the tags on this repository.
6. Releases
For the releases available, see the releases on this repository.
7. Authors
See the list of contributors who participated in this project.
8. License
This project is licensed under the MIT License - see the LICENSE file for details