Skip to content

Affan-Mushahid/KeepSake

Repository files navigation

KeepSake - The Personal Vault

Project Description:

KeepSake is a personal vault manager that lets you store and manage different kinds of data, like Passwords, Identity Cards, etc, in an encrypted format.

The Project also utilizes GUI which provides you with a simple and easy-to-use interface.

Table Of Contents:

  1. Features
  2. Working
    1. Login Screen
    2. Personal Vault
    3. Adding an Item
    4. Categories
    5. Operations on Individual Items
      1. View
      2. Edit
      3. Delete
    6. Settings
    7. Administrator Account
  3. Installation
  4. Building The Project Yourself
    1. Prerequisites
    2. Running The Project
  5. Credits
  6. License

Features:

  1. All data is encrypted which ensures your data can not be easily accessed.
  2. All functionality is very simple and doesn't require extensive knowledge
  3. Utilizes Qt GUI Library letting you store and retrieve all your data without having to learn any commands.
  4. Administrator accounts with additional functionalities like changing user passwords on demand.
  5. Categories that let you quickly access a specific type of item instead of having to search through all of them.

Working:

Login Screen:

When you first start the application you are presented with a login screen, you can either create a new account, or login to an existing one. If you are an Administrator, you can also click the Admin button and log into your Administrator account.

Personal Vault:

After logging in, you are presented with your personal vault. here you can add an item, choose a category, or go to settings.

Adding an Item:

When you click add, you are presented with a view to select different kinds of items. Once you click an option, you can enter a title and other relevant data, then after clicking Enter, your data is stored in the vault.

If you select a Password data type, you also get the option to generate a random password of a specified length which can include symbols as well.

Categories:

If you have a lot of items in your vault, it can be difficult to navigate to a specific one, therefore you can select a category from a list of categories on the left-hand side, this will allow you to view only items belonging to that specific data type so you can much more easily find your items.

Operations on Individual Items:

There are 3 different operations you can perform on every single data item.

View:

Allows you to view the data you have entered.

Edit:

Allows you to change your data (for example changing the title, or changing your password).

Delete:

If you no longer need a specific data item, you can easily delete it.

Settings:

This window allows you to change your email and password. It also allows you to log out which will store you data in encrypted form and log you out.

Administrator Account:

If you signed in as an administrator, you will have an Admin panel, this will let you change individual users password yourself by providing an email and the new password.

Installation:

  1. Download the latest release.
  2. extract it to your desired folder.
  3. run the KeepSake.exe file.

Building The Project Yourself:

Alternatively if you want, you can build the project yourself.

Prerequisites:

  • Having a working install of Qt (Project was built using Qt 6.63)
  • Having installed Visual Studio Community with the "Desktop Development with C++" module installed (Project was built using Visual Studio Community 2022)
  • Having installed the "Qt Visual Studio Tools" extension inside Visual Studio Community and set it up with your installed Qt program.

Running The Project:

  1. Clone the repository into your desired folder using:
git clone https://github.com/Affan-Mushahid/KeepSake.git
  1. Open the KeepSake.sln file.

Important

If you're running Visual Studio Community Version other than 2022, You might have to right-click the Project > Properties > General > Platform Toolset and change it to your version of Visual Studio Community.

  1. Build and Run the Project.

Credits:

  1. Affan Mushahid
  2. Hareem Aqeel
  3. Atika Ali
  4. Maryam Kamal

License:

KeepSake is a personal vault manager that lets you store and manage different kinds of data

Copyright (C) 2024 Muhammad Affan Mushahid, Hareem Aqeel, Atika Ali, Maryam Kamal

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

About

KeepSake is a personal vault manager that lets you store and manage different kinds of data, like Passwords, Identity Cards, etc, in an encrypted format. The Project also utilizes GUI which provides you with a simple and easy-to-use interface.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages