Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 1.58 KB

README.md

File metadata and controls

86 lines (54 loc) · 1.58 KB
Raw

Backend

A lightweight REST API built using FastAPI to serve Lock Genius's frontend. It allows users to store and manage their login credentials securely.

Features

See more in main README.

  • Endpoint to generate strong passwords with customizable options (length, uppercase, lowercase, numbers and symbols)
  • Dockerized for easy deployment and scalability

Prerequisites

Before running the application, make sure you have the following installed:

  • Python 3.11
  • Pipenv (or Pyenv or similar)
  • Docker
  • Docker Compose

Installation

  1. Clone this repository:

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

  2. Build and run the Docker containers:

    docker-compose up

  3. The API will be accessible at http://localhost:8000.

Configuration

  1. Create a virtual environment
    make build-venv
  1. Activate the virtual environment
    source venv/bin/activate
  1. Configure env file
    make load-env
  1. Install dependencies
    make requirements-dev

Linting

Run lint and type checkers to reformat files before commit

    make lint

Running

    make run-dev

See Makefile for more details.

To open documentation navigate to http://localhost:8000/docs

License

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