CodeWithAloha / kuka

Share video testimony.
MIT License
3 stars 5 forks source link

Documentation including Storybook #14

Closed johntimothybailey closed 3 years ago

johntimothybailey commented 3 years ago

Documentation

See the new CONTRIBUTIONS.md for getting started. This will be the new central / launching area for getting started and even can include FAQs and links to Product information (e.g. the InvisionApp work)

CLI

To encourage code over written word and rapid feature development for new comers, I am proposing a custom CLI (that leverages Gluegun)

Accelerating Project Startup

Instead of documenting in english all the steps to get start on the app, web, or "functions" (Firebase), do this in code. Doing so also helps the developers

Component, Screen, and More generators

Further more by having a CLI we can introduce generators (pull request coming soon!).

yarn make:screen and yarn mark:component

In doing so we can further help keep consistency and yet drive change by emphasizing changing standards in the generator templates.

New React Developers Welcome!

By taking an automation or assisted CLI approach we can help new engineers (including Jr. Developers) to be welcome in contributing as they'll have a guide through the CLI prompts and generators.

TODO

I didn't complete the tests yet :( As there is some scaffolding and mocking you must implement and those that I have from other projects are in TypeScript. I need to either convert them to regular JS or simply make the kuka/cli use TypeScript for the tests (which the later would be far easier).

Totally happy to block this PR without the tests.

Component Documentation (Product and Development)

By using Storybook we'll encourage Component Driven Development and Design with increased isolation. This gives the added benefit of not having to wait for a page to develop and see components!

To use Storybook see the Storybook section in the CONTRIBUTION.md document.

johntimothybailey commented 3 years ago

@davidrideout and @johnkmzhou Happy to rip out Storybook if the rest of this makes sense.