mirror of
https://github.com/neynarxyz/create-farcaster-mini-app.git
synced 2025-11-15 23:58:56 -05:00
chore: update local development readme section
This commit is contained in:
parent
880b149300
commit
d6791fe7c3
32
README.md
32
README.md
@ -44,10 +44,36 @@ The above command will generate a `.env` file based on the `.env.local` file and
|
||||
|
||||
## Developing Script Locally
|
||||
|
||||
This section is only for working on the script and template, if you simply want to create a mini-app and _use_ the template this section is not for you.
|
||||
This section is only for working on the script and template. If you simply want to create a mini-app and _use_ the template, this section is not for you.
|
||||
|
||||
To run the script locally just run:
|
||||
```
|
||||
### Recommended: Using `npm link` for Local Development
|
||||
|
||||
To iterate on the CLI and test changes in a generated app without publishing to npm:
|
||||
|
||||
1. In your installer/template repo (this repo), run:
|
||||
```bash
|
||||
npm link
|
||||
```
|
||||
This makes your local version globally available as a symlinked package.
|
||||
|
||||
|
||||
1. Now, when you run:
|
||||
```bash
|
||||
npx @neynar/create-farcaster-mini-app
|
||||
```
|
||||
...it will use your local changes (including any edits to `init.js` or other files) instead of the published npm version.
|
||||
|
||||
### Alternative: Running the Script Directly
|
||||
|
||||
You can also run the script directly for quick iteration:
|
||||
|
||||
```bash
|
||||
node ./bin/index.js
|
||||
```
|
||||
|
||||
However, this does not fully replicate the npx install flow and may not catch all issues that would occur in a real user environment.
|
||||
|
||||
### Environment Variables and Scripts
|
||||
|
||||
If you update environment variable handling, remember to replicate any changes in the `dev`, `build`, and `deploy` scripts as needed. The `build` and `deploy` scripts may need further updates and are less critical for most development workflows.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user