README.md

Lock Genius 🔐🛡️

👋 Say goodbye to weak passwords and hello to peace of mind

This mono-repository contains both the backend and frontend, providing a single unified codebase for more efficient development and collaboration.

📌 Table of Contents

• Lock Genius 🔐🛡️
  • 📌 Table of Contents
  • 🗣 Introduction
  • ✨ Features
  • Backend
  • Frontend
  • 🚀 Get Started
    • 🖥 Installation
  • 🚨 License

🗣 Introduction

Lock Genius is the only password manager you need. Secure, open source, and beautifully designed.

✨ Features

Backend

• Health routes
• Password routes
• Vault routes
• Collection
• Dev tools: lint, check typing, etc.
• Makefile
• Dockerization
• Unit testing
• Improve schemas validation

Frontend

• Social Login with GitHub
• Prisma and postgresql (schemas, etc)
• Devtools: ESLint, Prettier, etc.
• Generate password services integration
• Unit testing
• Health routes services integration
• Vault routes services integration
• Dockerization
• Improve services validation and types

🚀 Get Started

To clone the repository to your local machine, follow these steps:

1. Open a terminal.
2. Navigate to the directory where you want to clone the repository.
3. Execute the following command:

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

    cd lock-genius

🖥 Installation

Once you have cloned the repository, you may need to install the project's dependencies. Follow the instructions below to set up the backend and frontend.

• Backend instructions
• Frontend instructions

🚨 License

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