Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add scaffolding CLI tool #1408

Closed
wants to merge 128 commits into from
Closed

Conversation

Dhaiwat10
Copy link
Member

@Dhaiwat10 Dhaiwat10 commented Nov 6, 2023

Summary

This PR adds a new scaffold CLI tool that lets devs get started with a new full-stack Fuel project quickly by running:
pnpm create fuels

There are lot of file changes but most of them are just Node version corrections in all the package.jsons. The ones you have to review are the new package create-fuels and the template inside the folder template/nextjs.

Demo of the resulting scaffolded project

Screen.Recording.2023-12-01.at.1.32.52.AM.mov

^ This is what the users will get once they have run pnpm create fuels

Supports:

  • npm
  • yarn
  • pnpm
  • bun

Closes #1330
Closes #1522

@Dhaiwat10 Dhaiwat10 self-assigned this Nov 6, 2023
Copy link
Contributor

github-actions bot commented Nov 8, 2023

This PR is published in NPM with version 0.0.0-pr-1408-20231218152827

Dhaiwat10 and others added 10 commits December 16, 2023 00:59
Co-authored-by: Anderson Arboleya <[email protected]>
…1520)

* docs: Updated high-level doc links in README files

* docs: updating "/guide/" based doc hyperlinks

* docs: update "/sway/" and "/forc/" related doc urls

* docs: update "fuels-rs" doc links

* docs: update quickstart doc links

* docs: updated the quickstart docs link

* docs: added the changeset

---------

Co-authored-by: Anderson Arboleya <[email protected]>
Copy link
Contributor

@Torres-ssf Torres-ssf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still going throught the review process:

::: code-group

```sh [pnpm]
pnpm create fuels
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it need the project name?

This is the output that I am receiving

Screenshot 2023-12-18 at 18 45 16

I had to run pnpm create fuels myProject to make this work

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please run the command with the pr release tag like I mentioned here: https://fuellabs.slack.com/archives/C04LVA1UF7X/p1702913792062199

If you don't use the pr release tag, it uses the first, old cached version

Comment on lines +30 to +32
# (Make sure you cd into your new project directory first!)
pnpm install

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I cd to the project dir and run pnpm install, I am running into an error.
Screenshot 2023-12-18 at 19 09 06

I wonder if I am missing something.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the previous comment. Please use the pr release tag and it should work fine

@Dhaiwat10 Dhaiwat10 changed the base branch from rc/salamander to master December 19, 2023 11:44
@Dhaiwat10
Copy link
Member Author

Dhaiwat10 commented Dec 19, 2023

Closing this one since a lot of unwanted commits got included because of changing the base branch twice. Opening a new one soon.

@Dhaiwat10 Dhaiwat10 deleted the dp/scaffolding-tool-new branch February 23, 2024 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat Issue is a feature
Projects
None yet
6 participants