secundant / product-template Goto Github PK

• Documentation
• Enhancement
• Bug

In many cases we need to publish our packages to public or private npm registry, so, this template should provide simple but working example how to do it

Expected checks:

• No duplicates between ESM and CJS.
• Valid manifest.
• Correct types.

Tools:

• https://publint.dev/
• https://arethetypeswrong.github.io/

Eslint, prettier, TS, tests

Library should be based on:

• tailwind
• cva, clsx
• maybe atomic design

Complex long-term task, it will be splitted into detailed individual tasks.
Some goals:

• simple logo placeholder
• home page
• libraries documentation
• applications overview
• helpful links and resources
• blog with few articles

This is just an initial preparation phase, the following steps will gradually turn a minimalist setup into a well designed solution that can be taken entirely for complex projects or for simple ones with a little "hmm...okay, we don't need it...delete" process.

We should build and deploy "docs" app after one of trigger (to research):

• the merge PR which will contain any updates in this application
• specific branch updated
• specific tag/release/branch created

Templates should provide additional options and a user-friendly method for effortless removal if the user is uninterested.
One such opportunity is a finely tuned and highly personalized template library.

The Nx library generators are useful, but they restrict users to Nx's design vision.
I believe libraries could be cleaner than what Nx proposes, so I don't want to advocate for the Nx Integrated Repo approach without solid reasons.