⚡
LightningUserVault
  • Introduction
  • GETTING STARTED
    • Quickstart Guide
      • Docker Deployment
      • Local Deployment
    • Server Commands
  • Architecture
    • Overview
    • API Server
    • Data Storage:
      • Key-Value Databases
        • Pebbel DB
      • SQL Databases
        • PostgreSQL
    • Caching Mechanism:
      • MEMCACHE
  • Additional Features
    • Swagger
    • Postman Collection
    • Prometheus
    • Grafana
  • Releases
  • Contribution
Powered by GitBook
On this page

Introduction

LightningUserVault is a high-speed storage system designed for quick retrieval and management of user data. Think of it as a vault where you can swiftly store and fetch user information.

NextQuickstart Guide

Last updated 1 year ago

🤔 How Does It Work?

  1. Starting Up: Once you kick off the web server, you'll find two main endpoints:

    • Get Endpoint: Use this to fetch a user's data.

    • Post Endpoint: Use this to store a user's data.

  2. Modularity Showcase: The beauty of LightningUserVault lies in its modularity. It's a shining example of how a Go application can be structured into multiple modules. Plus, it's a guide on how to write tests for such applications.

  3. Storage Solutions:

    • Key-Value In-Memory Storage: For those who prefer lightning-fast data access.

    • SQL Storage: For structured data storage and complex queries.

    Currently, we're using Pebble for key-value storage and Postgres for SQL. But here's the cool part: the web app doesn't mind which specific system you use, as long as it fits our Storage interface.

  4. Caching Mechanism: Just like our storage, we've made caching modular too. If you can match our Cache interface, you can plug in any caching system you like. For now, we're using memcache.

Application Overview