feat: basic create-frames cli tool #143
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@davidfurlong ready for review |
|
how do we test this locally? |
|
@davidfurlong I did not find a way to do that. What I do is just running the |
|
Can you document local testing in the readme and then also run the debugger on startup? This is what currently shows up which makes it hard for users to use 
|
michalkvasnicak
force-pushed
the
feat/cli-tool
branch
from
1d03a69 to
71e962d
Compare
|
@davidfurlong I improved the installation of dependencies by providing a comment. Also I improved readme files a little and changed the |
templates/next/app/page.tsx
Outdated
| const previousFrame = getPreviousFrame<State>(searchParams); | ||
|
|
||
| const frameMessage = await getFrameMessage(previousFrame.postBody, { | ||
| // remove if you aren't using @frames.js/debugger or you just don't want to use the debugger hub |
There was a problem hiding this comment.
how does this work with deploying to production?
There was a problem hiding this comment.
Hm that would need a check if you are running on NODE_ENV=production and remove it in that case, if that's what is on your mind.
There was a problem hiding this comment.
Added the condition
There was a problem hiding this comment.
@davidfurlong is this ok with you?
| params.t || | ||
| (await select({ | ||
| message: "Choose a template for the project", | ||
| options: getTemplates().map((template) => ({ |
There was a problem hiding this comment.
would be great to have the existing templates here
There was a problem hiding this comment.
that way you would need to update the list manually each time.
There was a problem hiding this comment.
I think it is better to keep this as is otherwise it could easily happen that you forget to add a template here.
There was a problem hiding this comment.
Ah ok now I think I understand what you mean. Moving templates from starter to standalone templates.
There was a problem hiding this comment.
I added 2 more templates based on starters from examples folder. Would you like to get rid of examples altogether? I think that would be better to do in different PR.
|
we should probably also update the docs to use this |
michalkvasnicak
force-pushed
the
feat/cli-tool
branch
from
628c6e5 to
cf263b1
Compare
michalkvasnicak
force-pushed
the
feat/cli-tool
branch
from
bb82367 to
d1d5685
Compare
docs/pages/index.mdx
Outdated
| <HomePage.InstallPackage name="frames.js" type="install" /> | ||
| <HomePage.InstallPackage name="frames" type="init" /> |
There was a problem hiding this comment.
i think we should leave the install as the initial call to action since we have create-frames in the quickstart section
michalkvasnicak
force-pushed
the
feat/cli-tool
branch
from
d1d5685 to
7e7b20e
Compare
| @@ -0,0 +1,29 @@ | |||
| { | |||
| "name": "template-next", | |||
There was a problem hiding this comment.
is there a way for us to maybe deduplicate the framesjs-starter code?
There was a problem hiding this comment.
I would like that but that would require a lot of work, so perhaps it is better to split it to another PR.
feat: add next simple template fix: ignore some files when copying templates chore: remove fs-extra dep chore: add changeset remove comment chore: improve dependencies installation and run app in debugger by default chore: improve debugger hub comment chore: document installation chore: remove debug hub usage in case of production build chore: add two more examples based on starters chore: update to new dep
michalkvasnicak
force-pushed
the
feat/cli-tool
branch
from
7e7b20e to
55fab50
Compare
|
@stephancill it is ready. |
Change Summary
This PR adds
create-framespackage which can be used to init a project using a template.TODO
create-framescli toolnextstarter templatefs-extraand use justnode:fsMerge Checklist