KeyFlow 🔐

KeyFlow is a secure, open-source password manager browser extension that keeps your passwords safe with local encryption. Built with modern web technologies and designed with security in mind.

✨ Features

• 🔐 Local Encryption - All passwords encrypted locally, never sent to servers
• 🔑 Strong Password Generation - Generate secure passwords with customizable options
• 🚀 Auto-Fill - Automatically fill login forms with saved credentials
• 🔍 Search & Filter - Quickly find passwords with powerful search capabilities
• 🎨 Modern UI - Clean, intuitive interface built with React
• 🌐 Cross-Browser - Works on Chrome, Firefox, and Edge
• 🔒 Zero-Knowledge - Your data stays on your device
• 📱 Responsive Design - Works great on all screen sizes

🚀 Quick Start

Choose the installation method that works best for you:

Option 1: Install from Chrome Web Store (Recommended for Most Users)

Easiest method - One-click installation with automatic updates

1. Visit the Chrome Web Store

   • Go to KeyFlow on Chrome Web Store
   • Click "Add to Chrome" button

2. Confirm Installation

   • Click "Add extension" in the confirmation dialog
   • KeyFlow will be automatically installed and updated

3. Set Up Your Master Password

   • Click the KeyFlow icon in your browser toolbar
   • Create a strong master password
   • Start adding your passwords!

Option 2: Install from GitHub Releases

For users who want the latest version directly from GitHub

1. Download the Extension

   • Go to GitHub Releases
   • Download the latest release ZIP file for your browser
   • Extract the ZIP file to a folder on your computer

2. Install in Your Browser

   • Chrome: Go to chrome://extensions/, enable "Developer mode", click "Load unpacked", select the extracted folder
   • Firefox: Go to about:addons, click the gear icon, select "Debug Add-ons", click "Load Temporary Add-on", select manifest.json from the extracted folder
   • Edge: Go to edge://extensions/, enable "Developer mode", click "Load unpacked", select the extracted folder

3. Set Up Your Master Password

   • Click the KeyFlow icon in your browser toolbar
   • Create a strong master password
   • Start adding your passwords!

Option 3: Build from Source

For developers and users who want the latest development version

1. Clone the Repository

   git clone https://github.com/novasuitelabs/keyflow.git
   cd keyflow

2. Install Dependencies

   npm install

3. Build the Extension

   npm run build:extension

4. Install in Your Browser

   • Chrome: Go to chrome://extensions/, enable "Developer mode", click "Load unpacked", select the dist folder
   • Firefox: Go to about:addons, click the gear icon, select "Debug Add-ons", click "Load Temporary Add-on", select manifest.json from the dist folder
   • Edge: Go to edge://extensions/, enable "Developer mode", click "Load unpacked", select the dist folder

5. Set Up Your Master Password

   • Click the KeyFlow icon in your browser toolbar
   • Create a strong master password
   • Start adding your passwords!

First Time Setup

1. Create Master Password

   • Choose a strong, memorable master password
   • This password encrypts all your data locally
   • Important: Keep this password safe - it cannot be recovered!

2. Add Your First Password

   • Click "Add Password" in the popup
   • Fill in the website, username, and password
   • Save and you're ready to go!

3. Auto-Fill Setup

   • Navigate to a login page
   • KeyFlow will detect the form
   • Click the KeyFlow icon and select your saved password

🛡️ Security

KeyFlow prioritizes your security with multiple layers of protection:

Data Protection

• Local Storage: All data stored locally in your browser
• Strong Encryption: AES-256 encryption for all sensitive data
• Zero-Knowledge: No data ever leaves your device
• Secure Random: Cryptographically secure random number generation

Privacy Features

• No Tracking: No analytics or tracking code
• No Cloud: No cloud storage or synchronization
• No Logging: No sensitive data is logged
• Open Source: Transparent code for security review

Best Practices

• Use a strong, unique master password
• Keep your browser and extension updated
• Only use on trusted devices
• Regularly backup your password database

🛠️ Development

Prerequisites

• Node.js 18.x or higher
• npm or yarn
• Git
• Modern browser (Chrome, Firefox, Edge)

Building from Source

1. Clone the Repository

   git clone https://github.com/novasuitelabs/keyflow.git
   cd keyflow

2. Install Dependencies

   npm install

3. Start Development Server

   npm run dev

4. Build Extension

   npm run build:extension

5. Load in Browser

   • Follow the installation instructions above
   • Select the dist folder as the extension directory

Development Scripts

npm run dev          # Start development server
npm run build        # Build for production
npm run build:extension # Build extension files
npm run build:store  # Build extension and create Chrome Web Store ZIP
npm run lint         # Run ESLint
npm run preview      # Preview production build

Building for Production

When building your extension for production/distribution, you have two options:

Option 1: Using Build Script (Recommended)

npm run build:extension

• This builds the extension and copies files to the public folder
• Use the public folder for distribution or Chrome Web Store submission

Option 2: Using Chrome's Pack Extension

npm run build:extension

• Then go to chrome://extensions/
• Enable "Developer mode"
• Click "Pack extension"
• Select the dist folder
• This creates a .crx file for distribution

Note: Both methods work for Chrome Web Store submission - the store accepts both .zip (from Option 1) and .crx (from Option 2) formats.

Project Structure

keyflow/
├── src/                    # Source code
│   ├── components/         # React components
│   ├── scripts/           # Extension scripts
│   └── utils/             # Utility functions
├── public/                # Extension files
├── docs/                  # Documentation
├── .github/               # GitHub templates and workflows
└── README.md              # This file

📚 Documentation

• Contributing Guide - How to contribute to KeyFlow
• Development Guide - Detailed development information
• API Documentation - Internal APIs and interfaces
• Security Policy - Security guidelines and reporting
• Changelog - Version history and changes

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

Ways to Contribute

• 🐛 Report Bugs - Use the bug report template
• 💡 Suggest Features - Use the feature request template
• 🔧 Fix Issues - Pick an issue and submit a pull request
• 📝 Improve Documentation - Help make our docs better
• 🔒 Security Review - Review code for security issues

Getting Started

1. Fork the Repository
2. Create a Feature Branch

   git checkout -b feature/amazing-feature

3. Make Your Changes
4. Test Thoroughly
5. Submit a Pull Request

Code Style

• Follow the existing code style
• Use meaningful commit messages
• Add tests for new features
• Update documentation as needed

See CONTRIBUTING.md for detailed guidelines.

🐛 Reporting Issues

Found a bug? Have a security concern? We want to hear about it!

Bug Reports

• Use the bug report template
• Include steps to reproduce
• Provide browser and OS information
• Add screenshots if relevant

Security Issues

• DO NOT create public issues for security vulnerabilities
• Email security issues to [email protected]
• See SECURITY.md for more details

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Contributors - Everyone who has contributed to KeyFlow
• Security Researchers - Those who help keep KeyFlow secure
• Open Source Community - For the amazing tools and libraries we use

🔗 Links

• GitHub Repository
• Issue Tracker
• Releases
• Discussions

📊 Project Status

• Version: 1.0.0
• Status: Stable
• Browser Support: Chrome 88+, Firefox 85+, Edge 88+
• License: MIT

---

Made with ❤️ by Nova Suite Labs

Keep your passwords secure, keep them local, keep them with KeyFlow.