shaart/pstorage-multiplatform

Offline password storage desktop application with tray

Branch	Build Status	Code Quality
main
dev	todo

pstorage

pstorage - simple offline portable password storage application.

Table of contents

• How to use
  • Auth
  • Registration
  • Main view
  • Settings
  • System tray
  • More
• How to install
• How to build
• How to run for local development
• License

How to use

Auth

Once app is open you will see auth form:

If you don't have an account you can follow "Create a new account" button.

In case of wrong credentials you will see an error.

Registration

You can create any number of accounts with unique 'Username'.

Be careful: you can't restore your password if you forget it. Be sure that you remember it or write down in safe place.

Main view

After successful log in you will see main view.

If it's your first log in - passwords table will be empty.

Else you will see information about your passwords as on screenshot below.

On screenshot:

1. Column of passwords' aliases that you will see in System Tray passwords menu. On the right side of each record you see "Edit" button that can be used to change Alias value.
2. Placeholder of your password. Here also you can change your password's value (by "edit" button on the right side of column).
3. Action buttons:
   • "Copy" button - on press it copies password's value to Clipboard.
   • "Delete" button - delete password that you don't need anymore.
4. Form to add a new password.
5. Sidebar on the left side with navigation buttons and "Log out" button.

Settings

Here you can configure application.

• Notify about hiding to tray: if enabled - application will use Notification Center on window close

System tray

On launch application creates an icon in system tray.

After successful log in you will see there your passwords' aliases.

On screenshot above:

• Application name with version - use this to reopen the main window.
• Passwords menu - all your passwords' aliases. Click on specific element to copy it's password's value to clipboard. Note: It's blank if you don't have any password or in case if you are not authorized.
• Settings of current user.
• Quick 'log out' button.
• Exit button to shutdown application.

More

• Design: Figma

How to install on Windows

1. Download release build for your system from "Releases" section.
2. Run .msi installation file.
3. Open pstorage-multiplatform.exe in the root of installed directory.

How to install on MacOS

1. Download release build for your system from "Releases" section.
2. Run .dmg installation file. Drag pstorage-multiplatform.app into "Application" directory.
3. Open pstorage-multiplatform.app.

How to build

Requirements:

• JDK 17

Steps

1. Package platform binary using command

./gradlew packageReleaseDistributionForCurrentOS

2. Find built artifact in build\compose\binaries\main-release\

How to run for local development

If you need full application version:

./gradlew run

If you need to preview specific View (@Composable) in interactive way:

1. Go to src/jvmMain/com/github/shaart/pstorage/multiplatform/PreviewMain.kt
2. Edit view to needed
3. Run with flag app.preview = true

./gradlew -Dapp.preview=true run

License

Apache License 2.0