Hello and welcome to our password manager. This is a school project part of OSU where we were tasked with creating a fully functioning password manager hosted in the cloud. To learn more about the project requirements see this.
This section is a user guide showing you the three fundamental actions you can take in our application.
You have two, equally secure options, for signing into our application. You can either sign in with an existing google account or you can sign in with a more traditional email/password.
In the screenshot above you can see the account overview page which shows all of the saved passwords you have. Click on one to learn more!
When you click on a saved password you will be able to view/edit it. The UI above shows the following information:
- App name - name of the password
- Email - The email associated with the password
- Website URL (Optional) - The website associated with the password
- Password - The password itself
You also have the option to randomly generate a password if you would like a new one! We give you lots of customizability to create a secure password that works for you. Firstly, you can select what types of characters you would like included in the password. Secondly, you select the desired password length. After that you can click the circular arrow to regenerate passwords and the copy symbol to copy it to your keyboard!
We wrote lots of docs to explain different aspects of the applicaiton. You can find them in the /docs folder. Here are links to the different articles:
- Api reference - Full spec describing all of the API's this project uses.
- DB reference - Full spec describing the Cloud SQL database this project uses.
- Repository details - Describes how the github repo is setup.
- GCP Details - Notes on how GCP is utilized and how to work with it.
- Frontend readme - README file for the frontend of the application.
- Backend readme - README file for the backend of the application.
- Project structure - Details how the projects code is structured.
- Project observability - Details how we gain observability into the performance of our application.
Below are succinct instructions on how to run the application locally/push to the production instance.
# [OPTIONAL] If you have made changes to frontend, update the build artifact with the following instructions
# from the project root navigate to the frontend folder
cd frontend
# generate the build artifact by running the following npm command. make sure your npm environment is up to date
npm run build
# delete everything currently in the build folder
rm -rf ../backend/build/*
# copy the generated folder into the backend folder
cp -r build/* ../backend/build/
# DEPLOY LOCALLY
cd ../backend
python main.py
# DEPLOY TO PROD
cd ../backend
gcloud app deploy