Skip to content

Document and visualize your project's data structures and their interactions.

License

Notifications You must be signed in to change notification settings

stsh89/metropolis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Metropolis

This is a pet project for tracking software data structures and their interactions within a project.

Describe your models, entities, etc., and see how they relate to one another in a diagram (drawn using mermaid).

Tech stack of the app

Metropolis is composed of three main modules:

  • Gymnasium - data storage module written in Phoenix.
  • Temple - core logic module written in Rust.
  • Theater - client web application written in Rails.

See more details in the .docs folder or serve it with the mdbook:

// Install mdbook
cargo install mdbook

// Install mermaid plugin
cargo install mdbook-mermaid

// Serve documentation folder
mdbook serve ./docs -p 8000 -n 127.0.0.1

Roadmap

  • - Diagram data structures
  • - Generate Postgresql table migration(s) for Model(s).
  • - Generate programming language code (Rust, Ruby, Elixir) for created Model(s).
  • - Implement the ability to add use cases.