Monorepo for @platform modules.

---

 

API's and other structures will change (probably radically 🐷) prior to 1.x release.

• repo: platform-0.1.0 (deprecated, archived)
• repo: platform-0.2.0 (next)

 

 

Philosophy

As quoted on @isaacs post "Unix Philosophy and Node.js", Doug McIlroy's 4-point formulation of the Unix Philosophy:

 

1. Make each program do one thing well.
   To do a new job, build afresh rather than complicate old programs by adding new features.

2. Expect the output of every program to become the input to another, as yet unknown, program.
   Don’t clutter output with extraneous information. Avoid stringently columnar or binary input formats. Don’t insist on interactive input.

3. Design and build software, even operating systems, to be tried early, ideally within weeks.
   Don’t hesitate to throw away the clumsy parts and rebuild them.

4. Use tools in preference to unskilled help to lighten a programming task,
   even if you have to detour to build the tools and expect to throw some of them out after you’ve finished using them.

 

@isaacs follows this up with a thoughtful translation into nodejs terms. His whole post is worth the read, but here's a distillation:

• Working is better than perfect.
• Focus is better than features.
• Compatibility is better than purity.
• Simplicity is better than anything.

 

 

Development Setup

Extracting Secrets

When setting up a new developer (or your next machine). Extract all your "secret key" configuration files (eg. the .env and other .gitignore-ed configuration files that must never be commited) by running the msync command:

  msync hidden

...this will produce a folder that you can use to easily copy into your new working folder.

This temporarily generated folder must never be commited into the repo. Once you have your temporary folder assembled, transmit it to the next developer (or yourself on your next development machine) after appropriately editing out any API keys/tokens that are personally assigned to you. Send this over some sensibly secure "password/secret" transmission channel.

 

 

License

It's MIT all the way!

Plus...for a scintillating break down of this open-source classic, treat yourself to Kyle E. Mitchell's
"The MIT License line-by-line. 171 words every programmer should understand."

 

 

Be Forewarned

API's and other structures will change (probably radically 🐷) prior to 1.x release.

 

 

TODO ( WIP )

• npm deprecations on archived (obsolete/cleaned out) published code modules.