zachbutton / crystalize.js Goto Github PK

In progress on #5

On PR:

• Tests

On merge into main:

• Coverage and badges for README.md
• Commitizen + patch

On release

• Publish to npm

The API is still being finalized. Afterwards, we should introduce documentation.

This should be done after #1 and #2 are solved.

This work is being done in #15.

This is list of things that need done prior to a v1.0.0 release. This list is not final, and things may be added that delay the release.

• Composite modes (use multiple modes, i.e. in a min/max fashion)
• JSON import/export
• Finalize semver CI/CD
• Replace "Examples" readme section with functional demos in ./demos #16

There are several optimization opportunities that should be explored.

• The _generated values could potentially be used to jump-start the crystal passed into the next Crystalizer in functions like with, without, etc...
• Considered in relation to the above, we're creating a lot of new arrays and new initializations of Crystalizer. Consider where this can be reduced, while still maintaining external immutability.

These should be explored after #1 is solved.

We need demos of crystalize.js to place in the Samples section of the readme.

They should be fully qualified demos:

• Located in ./samples/[your-demo-name]
• Contain their own package.json and started via npm start
• Contain their own README.md with at least a summary of what it is

Big demos, small demos, frontend, backend... It doesn't matter, making this a #goodfirstissue.