Password Manager

Manage your passwords, generate new passwords randomly and store them.

Report Bug · Request Feature

Table of Contents

1. Screenshots
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

Screenshots

(back to top)

Built With

• Vue.js 3 + Composition API
• Pinia
• Express.js
• TypeScript
• Joi
• TypeORM

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/berkoca/password-manager.git

2. Install Client NPM packages

   cd client
   npm install

3. Install Server NPM packages

   cd server
   npm install

(back to top)

Usage

1. Start client application

   npm run serve

2. Start server application
   • vscode > Run > Start Debugging

(back to top)

Roadmap

• Front-end
  • Main Components
    • Password list
    • New password dialog
    • View password dialog
    • Edit password dialog
    • Notification
  • Vuex/Pinia
  • State management
  • Login page
• Back-end
  • Passwords CRUD
    • Listing passwords
    • Creating passwords via random creating algoritm
    • Editing passwords
    • Deleting passwords
  • Request body validation
  • User authentication
  • Logging
  • Creating env config

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Berk Koca - berk1937@gmail.com

Project Link: https://github.com/berkoca/password-manager

(back to top)