[Nuxt 3 - Pinia - Vuetify] Feat: Update README #1229
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
jdwilkin4
suggested changes
Apr 28, 2023
There was a problem hiding this comment.
I think this is a good start. 👍
But I think it would be better to use the template that Adam created a few weeks ago which aligns with the contributor feedback we received on how to enhance the readmes
A few things to consider:
- In the template, it starts with the
npm create @this-dot/startercommand and we should do the same here - We should have a Kit Organization / Architecture section so it matches the other starter kits READMEs
- We are missing the section on deployment. You can read more about that in the starter.dev spec Dustin created
jdwilkin4
suggested changes
Apr 28, 2023
|
|
||
| Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. | ||
| This starter kit features **Nuxt.js 3**, **Pinia** for client-side state management, and **Vuetify**. for styling |
There was a problem hiding this comment.
Suggested change
| This starter kit features **Nuxt.js 3**, **Pinia** for client-side state management, and **Vuetify**. for styling | |
| This starter kit features **Nuxt.js 3**, **Pinia** for client-side state management, and **Vuetify** for styling. |
| npm run dev | ||
| ``` | ||
| - [Vue v3.x](https://vuejs.org/) | ||
| - [Typescript](https://www.typescriptlang.org/) - Type checking |
There was a problem hiding this comment.
Suggested change
| - [Typescript](https://www.typescriptlang.org/) - Type checking | |
| - [TypeScript](https://www.typescriptlang.org/) - Type checking |
| ``` | ||
| #### Development | ||
|
|
||
| - start by [creating a new Starter Kit](link-to-wiki-page) project |
There was a problem hiding this comment.
I think we should add the wiki page link if available.
|
Kudos, SonarCloud Quality Gate passed!
|
jdwilkin4
added a commit
that referenced
this pull request
Jun 5, 2023
* Create project scaffolding (#481) * Create project scaffolding - install Nuxt3 with TypeScript - Install and Setup Tailwind - Install and Setup Pinia * removed rule * switch tailwind to vuetify * updated git ignore * add components and vuetify theme color * fix linting * added vitest tests * added storybook * chore: fix configs * feat(wip): add storybook config * chore: fix npm * feat: add vuetify icon and packagejson config * feat: update nuxt logo * chore: remove storybook config * fix: feedback comments * feat: nuxt 3 icon * feat: add start script * fix: api example * fix: stub fetch component --------- Co-authored-by: jesus padron <[email protected]> * [nuxt3-pinia-vuetify]: fix broken tests for counter example (#1217) * fix: broken tests for counter example * fix: pinning down dependencies * Feat: Fetch api example (#1226) * feat: fetch example logic * fix: testing and files scripts order * fix: removing duplicate express icon (#1231) * [Nuxt 3 - Pinia - Vuetify] Feat: Update README (#1229) * feat: add readme file * fix: typo * fix: feedback * fix: typos * [Nuxt 3 - Pinia - Vuetify] Fix: sanity check (#1234) * fix: sanity check * fix: feedback * Feat: add kit to cli (#1237) * feat: add kit to cli * feat: add kit to cli * refactor: applying code review changes * refactor: removing disabled attribute * Update starters/nuxt3-pinia-vuetify/.nvmrc Co-authored-by: Ihar Dziamidau <[email protected]> * Update starters/nuxt3-pinia-vuetify/package.json Co-authored-by: Ihar Dziamidau <[email protected]> * Update starters/nuxt3-pinia-vuetify/components/FetchExample/FetchExample.vue Co-authored-by: Ihar Dziamidau <[email protected]> * refactor: removing optional text from fetch * refactor: updating nuxt config * chore: pinning package.json vue version * fix: feedback from ihrar --------- Co-authored-by: Temitope Adesoji <[email protected]> Co-authored-by: jesus padron <[email protected]> Co-authored-by: Ihar Dziamidau <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Summary of change
Updated README.md file
Checklist