To conclude the works that had been conceived as of the NGI0 project plan (internal), as a developer I need to be aware of the next step that lies ahead, but also on the ones they are leading to.
Currently, for the first mission API anonymous view - create the definition is simple:
Departing from the point of not being a native Ruby coder, I can employ my current knowledge of computational systems to reverse engineer my current tasks. Rubberducking with myself here, I can explain them to me in a way, that will allow me to move forward towards the mission definition.
In that, I am first taking care of having a reproducible
development environment¹, being able to run tests on the codebase² and have the domain model of my application³ specified.
These specifications are written as
rspec tests and and will compare the model implementation against the expected definition.
From the side notes meanwhile scribbled from research at hack.allmende.io/incommon, I am able to infer more technical requirements to ease the development with
develop for me, and possibly others.
Testing and documentation
review and rewrite
rspec tests for compatibility with ActivityPub model.
Either bonus: add
apipie-rails HTTP API documentation
rswag to get testable API specifications and interactive API documentation with Swagger UI, eventually deprecates
rspec for HTTP API testing
Or bonus: add
redoc for a screen-printed, non-interactive API documentation
write and review
rswag API specification against CRUD requirement, adapt from
rdoc documentation, push to some place like
doc.incommon.cc/api or serve with an integrated HTTP file server at `api.incommon.cc/doc*
refactor README instructions to doc/, keep an overview there
mention the use of
Further down the road are examples how to use
byebug with Compose and adaptations to the
I will begin with a little further side tracking at the top of the list, as this investment in time will play out to be useful a lot in the future. Then the following will be much easier to tackle together.
@how Any opjections so far?
I am keen in resolving M1 with priority, since we were already supposed to start in September, and the work being done to recreate a development environment deemed neccessary to start nicely. In short:
We’reI’m late. I hope the steps above don’t just set the bar higher, but will allow for a less steep learning curve right after they are implemented.
This happens, as I am staying in an old farm house in the beautiful, yet empty countryside of Oderbruch (east Brandenburg), a dried swamp 100 km east of Berlin close to the Polish border. Heating the building with non-regenerative resources is time consuming, and doesn’t bring the warmth one would wish for thinking straight in hours.
Therefore development is often interrupted in a physically demanding environment on a degrowth farm out in the nowhere. But LTE is good and stable, and food is plenty and tasty