3 ms·

This is a great article that summarizes a method I’ve already used for my work over the years. When writing a new project from scratch ill make a bunch of struc

This is a great article that summarizes a method I’ve already used for my work over the years. When writing a new project from scratch ill make a bunch of structure (defining modules, writing pseudo code) then start to fill things out piece by piece. Often times ill need to adjust the structure as I go but helps for building a mental model of a new project (at least for me)

3abiton 2y ago
Do you mind sharing a concrete example of one your project s?
- captainkrtek 2y ago
  Nothing open source specifically to share, if you were looking for that kind of concrete example.
- 1659447091 2y ago
  not OP, but I do something similar with polylith[0]. Example structures [1] I'll create the base directories(e.g. www, api, auth). Then the components (e.g config, data, geo, mailer, utils, web etc) In each component I'll make a readme.md with what the component should do. Sometimes this leads to large components and when that happens I break the component directory into smaller ones (e.g. web-client, web-server, web-routes, web-middleware etc) and add a readme to those. Then (what I planned to do but usually skip) add function names to the interface file based on the readme, then work on the implementation (I usually end up going straight to this and wish I had created the interface "guide" cause now I've gone off track and need to clean it up) Not sure if this is a common way to polylith, or if I'm doing it wrong. It helps me keep track better than trying to search through outlines and notes that are scattered all over the place, or in an app I dont feel like opening or logging into, usually ending with me re-writing the same thing 2-3+ times. [0] https://polylith.gitbook.io/polylith https://polylith.gitbook.io/polylith [1] https://cljdoc.org/d/polylith/clj-poly/0.2.20/doc/production-systems https://cljdoc.org/d/polylith/clj-poly/0.2.20/doc/production...
  - captainkrtek 2y ago
    Thanks for the write up, this is pretty close to what I do as well.

3abiton 2y ago

Do you mind sharing a concrete example of one your project s?

captainkrtek 2y ago
Nothing open source specifically to share, if you were looking for that kind of concrete example.
1659447091 2y ago
not OP, but I do something similar with polylith[0]. Example structures [1] I'll create the base directories(e.g. www, api, auth). Then the components (e.g config, data, geo, mailer, utils, web etc) In each component I'll make a readme.md with what the component should do. Sometimes this leads to large components and when that happens I break the component directory into smaller ones (e.g. web-client, web-server, web-routes, web-middleware etc) and add a readme to those. Then (what I planned to do but usually skip) add function names to the interface file based on the readme, then work on the implementation (I usually end up going straight to this and wish I had created the interface "guide" cause now I've gone off track and need to clean it up) Not sure if this is a common way to polylith, or if I'm doing it wrong. It helps me keep track better than trying to search through outlines and notes that are scattered all over the place, or in an app I dont feel like opening or logging into, usually ending with me re-writing the same thing 2-3+ times. [0] https://polylith.gitbook.io/polylith https://polylith.gitbook.io/polylith [1] https://cljdoc.org/d/polylith/clj-poly/0.2.20/doc/production-systems https://cljdoc.org/d/polylith/clj-poly/0.2.20/doc/production...
- captainkrtek 2y ago
  Thanks for the write up, this is pretty close to what I do as well.