Skip to content

jinx-vi-0/passop

Repository files navigation

πŸ”‘ PassOP: Your Password Manager πŸš€

Hi there, Secure your online life with PassOP!

Overview πŸ“Œ

  • πŸ”’ **PassOP** is a simple and secure password manager built with React that allows users to save, view, edit, and delete their passwords.
  • πŸ’‘ It helps you manage your passwords efficiently and securely using modern encryption techniques.

Features

  • πŸ’Ύ Add Password: Save a new password with a website URL, username, and password.
  • πŸ“ Edit Password: Update an existing password easily.
  • ❌ Delete Password: Remove any saved password you no longer need.
  • πŸ“‹ Copy to Clipboard: Quickly copy website URLs, usernames, and passwords to your clipboard.
  • πŸ‘οΈ Show/Hide Password: Toggle visibility of passwords for added convenience.

Open-Source-Programmes 🀝

This project is now OFFICIALLY accepted for

GSSOC
HACTOBERFEST

Back To Top

Getting Started πŸš€

Prerequisites

Ensure you have the following installed:

  • Node.js (version 14.x or higher)
  • npm (Node package manager)
  • Vite (for running the React front-end)
  • MongoDB (local or cloud instance)

Installation

1. Clone the Repository:

git clone https://github.com/<your-username>/PassOP.git
cd PassOP

2. Setting Up the Backend:

  • Navigate to the backend folder:
cd backend
  • Install the required dependencies:
npm install
  • Set up your environment variables. Create or edit the .env file in the backend folder with the following:
    MONGO_URI=<your-mongodb-connection-string>
    DB_NAME=<your-database-name>
  • Run the backend server:
node server.js

3. Setting Up the Frontend:

  • Move back to the root directory:
cd ..
  • Install the front-end dependencies:
npm install
  • Run the React application using Vite:
npm run dev

4. Access the Application:

Now your password manager should be running locally!

Folder Structure πŸ“‚

PassOP/
β”œβ”€β”€ backend/ # Backend Node.js application
β”‚   β”œβ”€β”€ server.js # Main server file
β”‚   β”œβ”€β”€ .env # Environment configuration (not included in repo)
β”‚   β”œβ”€β”€ package.json # Backend dependencies
β”‚   └── ... # Other backend files
β”œβ”€β”€ frontend/ # React frontend application (using Vite)
β”‚   β”œβ”€β”€ src/ # React components and files
β”‚   β”œβ”€β”€ public/ # Public static files
β”‚   β”œβ”€β”€ package.json # Frontend dependencies
β”‚   └── vite.config.js # Vite configuration file
β”œβ”€β”€ README.md # This file
└── ...

Contributing ⭐

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

Code of Conduct πŸ“œ

Please make sure to review and follow the project's Code of Conduct when contributing.


Project Admin ⚑

Adarsh

Contributors

Big thanks to all the contributors who have helped make Passop a better platform! πŸŽ‰

Back To Top