Skip to content

Commit

Permalink
chore: expand init instructions, clean after init (#235)
Browse files Browse the repository at this point in the history
  • Loading branch information
markdalgleish authored May 10, 2023
1 parent c56b28e commit 3e7c15e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,16 @@ Click this button to create a [Gitpod](https://gitpod.io) workspace with the pro

## Development

- This step only applies if you've opted out of having the CLI install dependencies for you:
- First run this stack's `remix.init` script and commit the changes it makes to your project.

```sh
npx remix init
git init # if you haven't already
git add .
git commit -m "Initialize project"
```

- Initial setup: _If you just generated this project, this step has been done for you._
- Initial setup:

```sh
npm run setup
Expand Down
18 changes: 14 additions & 4 deletions remix.init/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,20 @@ const main = async ({ isTypeScript, packageManager, rootDirectory }) => {
const prodToml = toml.parse(prodContent);
prodToml.app = prodToml.app.replace(REPLACER, APP_NAME);

const newReadme = readme.replace(
new RegExp(escapeRegExp(REPLACER), "g"),
APP_NAME
);
const initInstructions = `
- First run this stack's \`remix.init\` script and commit the changes it makes to your project.
\`\`\`sh
npx remix init
git init # if you haven't already
git add .
git commit -m "Initialize project"
\`\`\`
`;

const newReadme = readme
.replace(new RegExp(escapeRegExp(REPLACER), "g"), APP_NAME)
.replace(initInstructions, "");

const newDockerfile = pm.lockfile
? dockerfile.replace(
Expand Down

0 comments on commit 3e7c15e

Please sign in to comment.