Skip to content

Commit

Permalink
Merge pull request #21 from souvikpramanikgit/feature-document
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
sudo-dpkg authored Oct 4, 2024
2 parents 38cf72b + dfa7143 commit 3209d57
Showing 1 changed file with 66 additions and 22 deletions.
88 changes: 66 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,53 @@
# PassOP
<!-- A simple and secure password manager application -->

A simple and secure password manager application built with React that allows users to save, view, edit, and delete their passwords with ease. PassOP helps you manage your passwords efficiently while keeping them safe.
# <p align="center" id="top">πŸ”‘ PassOP: Your Password Manager πŸš€</p>
<p align="center">

<div align="center">
<img src="https://readme-typing-svg.herokuapp.com?color=45ffaa&center=true&vCenter=true&size=40&width=900&height=80&lines=Manage+Your+Passwords+with+Ease!"/>
</div>

This project is a part of the **Girl Script Summer of Code (GSSOC)** and **Hacktoberfest**.
<h2 align="center">Hi there,<img src="https://raw.githubusercontent.com/nixin72/nixin72/master/wave.gif" height="40" width="40" /> Secure your online life with PassOP!</h2>

## Features
<p align="center">
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="700">
</p>

- **Add Password**: Save a new password with a website URL, username, and password.
- **Edit Password**: Update an existing password.
- **Delete Password**: Remove a saved password.
- **Copy to Clipboard**: Easily copy website URLs, usernames, and passwords to the clipboard.
- **Show/Hide Password**: Toggle visibility of the password field.
## Overview πŸ“Œ
<ul>
<li>πŸ”’ **<b>PassOP</b>** is a simple and secure password manager built with React that allows users to save, view, edit, and delete their passwords.</li>
<li>πŸ’‘ It helps you manage your passwords efficiently and securely using modern encryption techniques.</li>
</ul>

## Getting Started
<h2><img src = "https://media2.giphy.com/media/QssGEmpkyEOhBCb7e1/giphy.gif?cid=ecf05e47a0n3gi1bfqntqmob8g9aid1oyj2wr3ds3mg700bl&rid=giphy.gif" width = 30px height="38"> Features</h2>
<ul>
<li>πŸ’Ύ <b>Add Password</b>: Save a new password with a website URL, username, and password.</li>
<li>πŸ“ <b>Edit Password</b>: Update an existing password easily.</li>
<li>❌ <b>Delete Password</b>: Remove any saved password you no longer need.</li>
<li>πŸ“‹ <b>Copy to Clipboard</b>: Quickly copy website URLs, usernames, and passwords to your clipboard.</li>
<li>πŸ‘οΈ <b>Show/Hide Password</b>: Toggle visibility of passwords for added convenience.</li>
</ul>

Follow these instructions to run the PassOP project on your local machine.
## Open-Source-Programmes 🀝

### Prerequisites
### This project is now OFFICIALLY accepted for
<div align="center"> <img src="https://github.com/apu52/METAVERSE/assets/114172928/e79eb6de-81b1-4ffb-b6ed-f018bb977e88" alt="GSSOC" width="80%"> </div>
<div align="center"> <img src="https://hacktoberfest.com/_next/static/media/opengraph.9dc60c9d.png" alt="HACTOBERFEST" height="20%" width="80%"> </div>

Ensure you have the following installed:
<p align="center">
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="700">
</p>

<p align="right"><a href="#top"><img src="https://img.shields.io/badge/Move%20to%20top-Blue?style=plastic" alt="Back To Top"></a></p>

- Node.js (version 14.x or higher)
- npm (Node package manager)
- Vite (for running the React front-end)
- MongoDB (you'll need a MongoDB instance, either locally or on the cloud)
## Getting Started πŸš€

### Prerequisites
Ensure you have the following installed:
- [Node.js](https://nodejs.org/) (version 14.x or higher)
- [npm](https://www.npmjs.com/) (Node package manager)
- [Vite](https://vitejs.dev/) (for running the React front-end)
- [MongoDB](https://www.mongodb.com/) (local or cloud instance)

### Installation

Expand Down Expand Up @@ -86,7 +110,7 @@ npm run dev

Now your password manager should be running locally!

## Folder Structure
## Folder Structure πŸ“‚

```
PassOP/
Expand All @@ -104,10 +128,30 @@ PassOP/
└── ...
```

## Contributing
## Contributing ⭐

We welcome all contributions! Read our [CONTRIBUTING.md](./CONTRIBUTING.md) to get started building! πŸ› οΈ

## Code of Conduct πŸ“œ

Please make sure to review and follow the project's [Code of Conduct](./CODE_OF_CONDUCT.md) when contributing.

<br>

## Project Admin ⚑
<table>
<tr>
<td align="center">
<a href="https://github.com/jinx-vi-0"><img src="https://avatars.githubusercontent.com/u/120160355?v=4" width=150px height=150px /></a>
<h4>Adarsh</h4>
</td>
</tr>
</table>

<div><h2><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" width="35" height="35"> Contributors</h2></div>

For contribution guidelines and instructions, please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
Big thanks to all the contributors who have helped make Passop a better platform! πŸŽ‰

## Code of Conduct
<a href="https://github.com/jinx-vi-0/passop/graphs/contributors"> <img align="center" src="https://contrib.rocks/image?max=100&repo=jinx-vi-0/passop"/> </a>

Please make sure to review and follow the project's [Code of Conduct](./CODE_OF_CONDUCT.md) when contributing.
<p align="right"><a href="#top"><img src="https://img.shields.io/badge/Move%20to%20top-Blue?style=plastic" alt="Back To Top"></a></p>

0 comments on commit 3209d57

Please sign in to comment.