remix-run / grunge-stack

The Remix Stack for deploying to AWS with DynamoDB, authentication, testing, linting, formatting, etc.
https://remix.run/stacks
MIT License
438 stars 95 forks source link

chore: expand init instructions, clean after init #149

Closed markdalgleish closed 1 year ago

markdalgleish commented 1 year ago

This change was motivated by some upcoming work in create-remix but this is still a useful change in the meantime that can go out immediately.

From an end user perspective, if the remix.init script runs during the create-remix flow, the npx remix init instructions are no longer present in the readme since they're redundant and just add noise.

For those that didn't already run the remix.init script (either because they opted out of installing dependencies, or because they cloned this repo directly), the instructions are now much clearer since they're not conditional — you don't have to remember whether or not you opted out of installing dependencies anymore. We also now make it clear that this script makes changes to your project that are intended to be committed.