mpareja/gearshaft

Road to Release 1.0.0

mpareja opened this issue · 3 comments

mpareja commented

Gearshaft is very much operable at the moment. The single biggest inhibitor is the lack of documentation.

  • Finalize PositionStore usage when operating Consumer Groups
  • Documentation
    • Create & deploy website
    • Getting Started
    • Message Store
    • Messaging
    • Entity Projection
    • Entity Store
    • Host
      • pause/unpause/stop parameters
    • Consumer
    • Document Store
    • Document Projection
      • versionField importance for joining streams
    • Logging & Operations
  • Example Project (https://github.com/mpareja/gearshaft-example)
  • Implement EntityCache support
chill-cod3r commented

is this effort still underway?

Is there a trackable active effort going into this? I'm interested in learning how this library works and also documenting it along the way. I have a basic knowledge of interacting with message-db from nodejs.

mpareja commented

Hi @wolfejw86.

Your best bet is to checkout the extensive Eventide documentation (http://docs.eventide-project.org/). Many of the Eventide concepts have Gearshaft equivalents. The example project is what I typically point people to for concrete examples of how to use the various Gearshaft modules.

Most folks using Gearshaft today have invested in learning about the Eventide stack, so Gearshaft-specific documentation hasn't been a pressing issue.

I'm certainly open to contributions if you're thinking of taking the plunge and documenting things along the way!

chill-cod3r commented

Gotcha - thanks for the response. Because some of the concepts are newer to me it takes a while for me to "translate" the docs on eventide's site into actionable nodejs code related to this project. The example app appears to have what I need, it's just a little slower going than I'd like (mostly my fault). It sounds like you're saying that there should be pretty much 1-1 feature parity between this project and the eventide ruby implementation though, which is a good "backstop" for me to work against. Thanks again, I'll document as I go and if I get something good going I'll be happy to contribute to this space.