react-boilerplate-cra-template icon indicating copy to clipboard operation
react-boilerplate-cra-template copied to clipboard

docs: add/update documentation, upgrade media query utility, upgrade dependencies, & more

Open qeleb opened this issue 1 year ago • 3 comments

This pull request has a lot of things in it, but it's really scaled-back compared to the last one.

  1. Add documentation about Yarn v3 to make upgrading easy (and add those files to .gitignore)
  2. Upgrade media query utility to allow minification (includes test)
  3. Upgrade some dependencies (and remove @types/react-router because it includes its own types now)
  4. VS Code lint on save
  5. Make changelog headers more consistent (and upgrade commitlint to create all new versions as H2's going forward
  6. Make enums const where possible
  7. Add myself as a contributor
  8. Improve some documentation about vs code extensions, testing with jest, etc.
  9. Change index.tsx to create root with ReactDOM similarly to how the CRA template does it, because it is more readable.

qeleb avatar Sep 18 '22 22:09 qeleb

Pull Request Test Coverage Report for Build 3078783540

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 99.679%

Totals Coverage Status
Change from base Build 3037812048: 0.0%
Covered Lines: 250
Relevant Lines: 250

💛 - Coveralls

coveralls avatar Sep 18 '22 22:09 coveralls

Apologies for not noticing the commitlint requirements sooner. I am developing on Windows, so the .sh files didn't execute, preventing me from being warned about commit message formatting.

qeleb avatar Sep 18 '22 22:09 qeleb

In my next PR, I plan to:

  1. Remove web-vitals. It's built into modern browsers anyway, so it seems pointless. I personally think it would make more sense to leave the service worker registration call here like it was in CRA template a couple years ago.
  2. Add documentation (and maybe an internal script) to add a caching service worker to the app
  3. Add documentation about ejecting CRA, and possibly using CRACO for some changes to the configurations in react-scripts.

qeleb avatar Sep 18 '22 22:09 qeleb

Hey. Thanks a lot. Sorry for the delay. Im on vacation for 2 weeks. I ll check this perhaps afterwards :(

Can-Sahin avatar Sep 26 '22 04:09 Can-Sahin

@Can-Sahin I hope you enjoyed your vacation! When you get a chance, could you take a look at this PR? I have a few more things I'd like to do after it's merged.

Also, I've been digging into React Scripts... there is so much stuff in there that needs updating. It's sort of sad to see how poorly maintained the CRA core has become. I may write my own soon... but if I do, I'd probably build it with SolidJS or maybe Preact.

qeleb avatar Oct 14 '22 05:10 qeleb

When you come back from vacation your actual work piles up on you :) I'll be looking next week :)

About CRA yes it's not as active as old days but it's mature and accepted by the community. It always comes down to the community of the software in the end. I and some other people I know have maintained CRA apps (mines are simpler) for 4-5 years now and trust me the custom and new stuff always come and bite you in harsh ways, but the motivation in the beginning feels good I know :)

Can-Sahin avatar Oct 14 '22 05:10 Can-Sahin

Thanks. I wanna release a version with your changes in couple of days. Sounds good?

Can-Sahin avatar Oct 22 '22 18:10 Can-Sahin

yes it does. should the editor not auto format? i love this feature

qeleb avatar Oct 22 '22 21:10 qeleb