Skip to content

Latest commit

 

History

248 Commits

Folders and files

Repository files navigation

Endpoint Data Management System (EDMS)

Standalone system for a team building microservices

Quick Start

  • EDMS runs locally as a standalone service
  • No installation or setup necessary.
  • Need to have some Container application like Docker, Podman, Singularity etc running
git clone https://github.com/hashedtokens/edms
git checkout -b latest origin/latest
cd init 
docker compose build
docker compose up
# open browser type, localhost:3911

Core Idea

During development stages endpoints may not change, but the associated QP pairs keep changing. The change is not just linked to the QP schemas which might be static or in rare cases well defined, but also related to the data bound to the keys contained in the QP. So, it leads to a problem we define as EQP Chaos.

Eliminate EQP Chaos

  • Communication breaks when multiple servers talking to each other with evolving QP pairs per E
  • Systemic mess when a simple change in either of E, Q or P happens
  • Coordination delays accruing technical debt, when several team members are modifying microservice data
    • ❌ endpoints not versioned
    • ❌ endpoints not mapped against all the linked QP pairs per E
    • ❌ endpoint inventory summary and management
    • ❌ no inbuilt tool for doc generation of EQP pairs

So, EDMS helps to reduce the chaos so that development progresses without hassle, regardless of the team size, without having to compromise speed or efficiency.

Features

  • ✅ Web View (EQP Docs) - Users can create a hostable static website view for all the filtered set of endpoints
  • ✅ Repo Ready (Git friendly) - Versioned EQP Data can be generated in a way that's easy to push to a repo
  • ✅ Test View - Endpoints can be tested in real-time with advanced options
  • ✅ Filter / Merge Data - Endpoints from multiple sources / team members can be easily filtered into independent collections or merged into one collection
  • 🚧 Share - Sharing endpoints with teams Work-In-Progress
  • 🚧 Online Backup - Securely backup your EQP data online Work-In-Progress

Symbols

  • E : Endpoint
  • Q : Request
  • P : Response

EQP : All data related to Endpoints

About

Endpoint Data Management System (EDMS)

Topics

Resources

Stars

9 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages