Password Locker

An application that allows the user to create an account and save various credentials

PasswordLocker.mp4

Contribution

Emmaculate Kamau

Technology used

Python

Requirements

An IDE such as VS code with Python version 3 installed and a terminal.

Setup and Instruction

1. Clone the repository at here.
2. Extract and open the folder on VS code or navigate to the folder on your terminal.
3. Run chmod +x run.py and ./run.py respectively on the terminal.
4. Interact with the application.

Development

To fix a bug or enhance an existing module, follow these steps:

• Fork the repo
• Create a new branch (git checkout -b improve-feature)
• Make the appropriate changes in the files
• Add changes to reflect the changes made
• Commit your changes (git commit -am 'Improve feature')
• Push to the branch (git push origin improve-feature)
• Create a Pull Request

Behaviour Driven Development

BDD focuses on how the user will interact with the application.

What you will see and experience:

1. On the terminal, you'll confirm whether you have an account or not.
2. If no, you'll be prompted to enter a username and a password. A choice to generate a password is also available.
3. Application will confirm that an account has been created and revert to ask whether you have an acc, this time you can respond with yes and log in.
4. Once logged in, you will be presented with shortcodes that will aid in navigation.
5. Shortcode - cc will allow you to create a credential. You will be prompted to enter an account name e.g facebook, a username, an email and a password. An option to generate a password for the account is also provided.
6. Shortcode - dc will allow you to display all the credentials in the acc.
7. Shortcode - fc will allow you to search for an account using the account name provided.
8. Shortcode - ex will allow you to exit the application.

Known Bugs

If you find a bug or would like to request a new function, reach out to me via Email: emmaculatewkamau@gmail.com or on LinkedIn

License

MIT

Copyright (c) 2022 Emmaculate Kamau

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.