Lock Genius 🔐🛡️

A secure and modern password manager built with Next.js.

📌 Table of Contents

• Lock Genius 🔐🛡️
  • 📌 Table of Contents
  • 🗣 Introduction
  • ✨ Features
  • 🛠 Tech Stack
  • 🖥 Installation
  • 🚨 License

🗣 Introduction

Lock Genius is a simple yet powerful password manager you need. Built with modern web technologies and security best practices.

✨ Features

• Social Login with GitHub
• Secure Password Generation
  • Cryptographically secure random generation
  • Customizable password options (length, character sets)
  • Copy to clipboard functionality
• Health Check API
• Database Integration
• Password Vault Management
• Unit Testing

🛠 Tech Stack

• Framework: Next.js 14 with App Router
• Database: PostgreSQL with Prisma ORM
• Authentication: NextAuth.js
• UI: Tailwind CSS, Radix UI
• Testing: Jest, React Testing Library
• Type Safety: TypeScript
• Code Quality: ESLint, Prettier
• API: Built-in Next.js API Routes

🖥 Installation

Prerequisites

1. Install nvm (Node Version Manager):

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

2. Install and use the correct Node.js version:

   nvm install
   nvm use

3. Install pnpm:

   npm install -g pnpm

Project Setup

1. Clone the repository:

   git clone https://github.com/iguit0/lock-genius.git
   cd lock-genius

2. Install dependencies:

   pnpm install

3. Set up environment variables:

   cp .env.example .env.local

4. Set up the database:

   pnpm db:setup

5. Start the development server:

   pnpm dev

Visit http://localhost:3000 to see the application running.

Additional Commands

• Database Management:

  • pnpm db:reset - Reset database (⚠️ Warning: This will delete all data)
  • pnpm db:studio - Open Prisma Studio for database management

• Testing:

  • pnpm test - Run tests
  • pnpm test:watch - Run tests in watch mode
  • pnpm test:coverage - Run tests with coverage report

• Code Quality:

  • pnpm lint - Run ESLint
  • pnpm lint:fix - Fix ESLint issues automatically
  • pnpm format:check - Check code formatting
  • pnpm format:write - Format code automatically
  • pnpm typecheck - Run TypeScript type checking

• Docker (if using Docker):

  • pnpm docker:up - Start Docker services
  • pnpm docker:down - Stop Docker services
  • pnpm docker:logs - View Docker logs

🚨 License

This project is licensed under the MIT License. Refer to the LICENSE file for more information.