Added v0.1.0 of create-nuxt3-app

[zoey-kaiser]

Closes #3
Contributes to sidebase/sidebase#59

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]

Successfully published first alpha version for testing:

npx [email protected]

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]

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]

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 [email protected]

[BracketJohn]

this count is outdated!

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

[zoey-kaiser]

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

[BracketJohn]

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

[zoey-kaiser]

Sure sounds good!

[BracketJohn]

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

[zoey-kaiser]

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?

[BracketJohn]

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

[zoey-kaiser]

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!