From dfa7143c03795333a4ae0bffe918a1a10b8428c3 Mon Sep 17 00:00:00 2001 From: souvikpramanikgit Date: Fri, 4 Oct 2024 02:13:41 +0530 Subject: [PATCH] Add some style in docs --- README.md | 88 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 66 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 4a54d28..b3fe6cd 100755 --- a/README.md +++ b/README.md @@ -1,29 +1,53 @@ -# PassOP + -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. +#

🔑 PassOP: Your Password Manager 🚀

+

+ +

+ +
-This project is a part of the **Girl Script Summer of Code (GSSOC)** and **Hacktoberfest**. +

Hi there, Secure your online life with PassOP!

-## Features +

+ +

-- **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 📌 + -## Getting Started +

Features

+ -Follow these instructions to run the PassOP project on your local machine. +## Open-Source-Programmes 🤝 -### Prerequisites +### This project is now OFFICIALLY accepted for +
GSSOC
+
HACTOBERFEST
-Ensure you have the following installed: +

+ +

+ +

Back To Top

-- 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 @@ -86,7 +110,7 @@ npm run dev Now your password manager should be running locally! -## Folder Structure +## Folder Structure 📂 ``` PassOP/ @@ -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. + +
+ +## Project Admin ⚡ + + + + +
+ +

Adarsh

+
+ +

Contributors

-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 + -Please make sure to review and follow the project's [Code of Conduct](./CODE_OF_CONDUCT.md) when contributing. +

Back To Top

\ No newline at end of file