Skip to content
This repository was archived by the owner on Jan 10, 2023. It is now read-only.

Added v0.1.0 of create-nuxt3-app#2

Open
zoey-kaiser wants to merge 18 commits into
mainfrom
add-cli-v1
Open

Added v0.1.0 of create-nuxt3-app#2
zoey-kaiser wants to merge 18 commits into
mainfrom
add-cli-v1

Conversation

@zoey-kaiser

@zoey-kaiser zoey-kaiser commented Oct 4, 2022

Copy link
Copy Markdown
Member

Closes #3
Contributes to sidebase/sidebase#59

FfmjcjDWAAMBy7d

I decided to not finish the with-server option for release 0.1.0, as I am still struggling with a few issues that I will track in another issue. As discussed beforehand, we want to release an initial version to test the functionality after publishing, see how well it works and find any bugs we need to fix.
Once we release this version we can begin focusing on adding new options (first being with-server)

@zoey-kaiser zoey-kaiser changed the title Added create-nuxt3-app and cn3a-plop-files packages Added V1 of create-nuxt3-app Oct 21, 2022
@zoey-kaiser zoey-kaiser changed the title Added V1 of create-nuxt3-app Added v0.1.0 of create-nuxt3-app Oct 21, 2022
@zoey-kaiser

zoey-kaiser commented Oct 21, 2022

Copy link
Copy Markdown
Member Author

Successfully published first alpha version for testing:

npx create-nuxt3-app@0.0.1-alpha.3

Tests:

  • Create project without github actions
  • Create project with github actions
  • npm ci && npm run dev in version without github actions
  • npm ci && npm run dev in version with github actions
  • create a project in a folder where a project already exists and have it throw an error

@BracketJohn

BracketJohn commented Oct 21, 2022

Copy link
Copy Markdown

I tested it out with our PM @LukSteib, initial feedback and observations:

  • it works and the UX was great 🎊
  • requested changes:
    • should be create-nuxt3-app in the ascii font
      • maybe then also "by @sidebase" instead of sidestream?
    • the initial cd command should not have a leading slash -> that would imply cd-ing into a root folder which does not work
    • Let's add a disclaimer below the ascii art that reads something like: "create-nuxt3-app is in early development. Initially it uses https://github.com/sidebase/sidebase as a nuxt 3 fullstack beaseline, but should soon support more different configurations"
    • please add the MIT license, if not already done so: https://github.com/sidebase/nuxt-session/blob/main/LICENSE
    • please add the badges we also have in the nuxt-session readme
    • the README.md needs a bigger overhaul.
      • at the moment it can still be minimal but should at least have:
        • badges
        • one-sentence pitch (the quoted line at the very top of the nuxt-session readme / sidebase readme)
        • quick start
        • features
        • optional: logo
      • inspirations
        • sidebase readme,
        • nuxt-session readme
        • create-nuxt-app

@zoey-kaiser

Copy link
Copy Markdown
Member Author

I implemented the requested changes:

You can see the readme here: https://www.npmjs.com/package/create-nuxt3-app

You can test the new messages with: npx create-nuxt3-app@0.0.1-alpha.4

Comment thread packages/create-nuxt3-app/README.md Outdated
Comment thread packages/create-nuxt3-app/README.md Outdated
Comment thread packages/create-nuxt3-app/README.md Outdated
Comment thread packages/create-nuxt3-app/package.json
Comment thread packages/create-nuxt3-app/package.json Outdated

See more information about usage on the main [ReadMe](../../README.md).
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

this count is outdated!

please ctrl + shift + f and ensure that sidebase is replaced with create-nuxt3-app (:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It should not be. I changed the values at the bottom of the ReadMe to reflect the correct repo!

Comment thread packages/create-nuxt3-app/README.md Outdated
Comment thread packages/create-nuxt3-app/README.md
- Testing framework
- ViTest (currently included)

We are always looking for more options to include! Join in on the conversation [here](https://github.com/sidebase/sidebase/issues/70)!

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

maybe we can move that issue here / open a new one here and then reference the old one?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Sure sounds good!

Comment on lines +63 to +67
"chalk": "^5.1.2",
"defu": "^6.1.0",
"fs-extra": "^10.1.0",
"node-plop": "^0.31.0",
"prompts": "^2.4.2"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

please check if all of these are still actually used in the final package (:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I do use all of them, however I (generally still) often wonder if I really need them as dependencies or if it is enough to include them as dev-dependencies.

On all of their installation pages they were being added as non dev-dependencies. Does that mean they need to be added regularly or can I check it another way?

Comment thread packages/create-nuxt3-app/src/actions.ts Outdated
@@ -0,0 +1,231 @@
![sidebase-logo-for-dark](.github/sidebase_logo_dark_icon_font_for_dark_bg_long.svg#gh-dark-mode-only#gh-dark-mode-only)
![sidebase-logo-for-light](.github/sidebase_logo_light_icon_font_white_bg_long.svg#gh-light-mode-only)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Can we already make this less sidebase-y?

I would:

  • remove most of the sidebase references
  • then remove all assets that become irelevant (e.g. the .github/ pngs and svg that make this package big)
  • link to the original sidebase for further documentation
  • style this more like a scaffold / starter readme for a project

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Sure thing! I will actully do this a bit differently. I will make a new branch on sidebase/sidebase in which I will remove most of the branding. That way we can merge main into it whenever we update anything to make it easier in the future to upgrade the scaffold!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document progress on create-nuxt3-app

2 participants