aboveyunhai / chakra-dayzed-datepicker

Chakra UI + Dayzed = datepicker
https://aboveyunhai.github.io/chakra-dayzed-datepicker/
MIT License
223 stars 46 forks source link

Document Development Process #15

Closed david-morris closed 2 years ago

david-morris commented 2 years ago

It would be easier to work on this project if it was documented in the README how to get from a git repo of this package to an installed forked version.

For example, I just added david-morris/chakra-dayzed-datepicker to my yarn classic project's package.json, installed, and ran npm install && npm run build in the node_modules/chakra-dayzed-datepicker directory. My changes were present, but the chakra theme was broken on the datepicker component. If I knew the correct way to install that, I would have been more confident in my PR.

aboveyunhai commented 2 years ago

Your question contains two topics. If you want to install a forked version, it's a npm question, I think the answer can be found on Stackoverflow. It's not particular for this lib.

For the development of this package, you can clone this package, and then run npm run start in top level folder to watch the file changes, and then go into the example folder, do npm run start to test the package immediately. All commands are in the package.json file.

aboveyunhai commented 2 years ago

Technically, package.json is the development document for many simple libs.