I'd love to help with documenting various components, would help me learn it and benefit everyone.
But yes documentation is the biggest limiting factor for attracting new people to the project IMO
We discussed the best way is to focus documentation here: https://github.com/CodeAdventure/meteor-space/blob/master/README.md, then link out to more detailed docs for the sub-projects
This is an example of Space.messaging.Api https://github.com/CodeAdventure/space-ui/blob/master/examples/TodoMVC/server/todos_api.coffee#L7
The example is a but out of date with current thinking though. It still uses mediators whereas we’re now using Blaze Components instead
The Todo app is also not complex enough to demonstrate the cqrs package capabilities, so we really need to put togethe an example from a more complex domain
To clarifty the example I posted, in a CQRS app you would want to be passing a command to the commandBus instead of updating the collection here. The command is constructed on the client and passed as a serialsed, type-checked object. A handler in the domain layer handles the command, loading up the aggregate, and calling it’s method.
# Somewhere on client
Space.messaging.Api.call MyCommandclass @MyApi extends Space.messaging.Api
@method MyCommand, (context, command) ->
@commandBus.send commandclass @MyAggregateHandler extends Space.messaging.Controller
Dependencies:
repository: ‘Space.cqrs.Repository’
...
@handle MyCommand, (command) ->
aggregate = @repository.find MyAggregate, command.aggregateId
aggregate.doSomething(command)
@repository.save aggregate
space-messaging is very badly documented at the moment, but i will be putting something together asap! For starters you can also take a look at two of my blog posts that cover a bit of the ground and philosophy behind the whole space framework:
Hey everyone, we move our private discussion about space/orionjs integration here because we figured that
space-cqrsis not a good fit for the ORM based orionjs solution anyway. But we sparked the idea of building a good example application that shows the concepts and benefits of DDD / CQRS with space-cqrs
Also we discussed the value of "general" purpose space modules (like
orders and payments) that could be dropped into your application and configured. This would provide great examples of how to model a self-contained bounded context and possibly draw more attention to space (get more devs on board).
I setup the basic structure for an example shop app that could showcase how to configure and use the
ordersand paymentsBCs: https://github.com/SpaceJs/cqrs-shop-example
And i will also sponsor some of the value objects that i modeled in my Prisma application. I think a general purpose, configurable value object repository would be really amazing for the community. Since
package.js is programmable in Meteor we can use environment vars to include only those value objects that are needed by modules / apps.
I really like the approach of configurable file inclusions! Works like charm with Meteor :-)
What are you working on currently?
Continued to work on the space-cqrs example app, fleshed out a basic UI using semantic-ui for showing the products of the shop ;-) https://github.com/SpaceJs/cqrs-shop-example/tree/develop
you have to symlink the https://github.com/SpaceJs/value-objects into the packages folder atm and make a copy of the
environment.example.sh to environment.sh. Then run the app via the ./run.sh shell script.
it already uses three of the general purpose value objects and only loads those that are configured via the
environment.shfile :-)
Hey Dominik, the new ideas around a repository of components is exciting. I’ve just reviewed space:value-objects, great start. I do wonder though if we are best keeping each one in it’s own package. Seems like we are misusing ENV variables for application reliant configuration?
Pros:
- No need to learn a new dev process since we would be using the starndard tools.
- Anyone can add Value Objects by writing a new package and realeasing to Atmosphere. We can review and maintain a directory of packages in the Space docs.
- Only the code required by the app is pulled into a project.
rhyslbw:space-vo-foo
rhyslbw:space-module-orders