|
1 | | -# NOTE: Known issues with package managers |
2 | | -The use of **Yarn Berry** should work without any problems (since this is the package manager I used and considered when setting up Nuxt-3-Starter). Using **npm** should work fine as well, if there should be problems with Pinia one can also use `npm i --legacy-peer-deps`. |
| 1 | +# Nuxt 3 Starter |
| 2 | +This repo contains a fully configured nuxt 3 instance supporting TypeScript and several considered as useful libraries, fully configured and ready to use in real world projects! Nuxt 3 is a JavaScript meta framework on Vue 3 [learn more](https://v3.nuxtjs.org/guide/concepts/introduction). |
3 | 3 |
|
4 | | -There where some issues when using some package managers with nuxt 3 stable, as mentioned in the following threats: |
| 4 | +-- |
| 5 | +## 🚀 How to get startet |
| 6 | +1. Clone or download this repo. |
| 7 | +2. Run `yarn` or `yarn install`. |
| 8 | +3. Run `yarn dev` to run the local dev environment. |
5 | 9 |
|
6 | | -- https://github.com/nuxt/framework/issues/581 |
7 | | -- https://github.com/nuxt/framework/issues/5411 |
8 | | -- https://github.com/nuxt/framework/discussions/3546 |
| 10 | +-- |
9 | 11 |
|
10 | | -Anyways, feel free to try the Package Manager of your choice and let me know if it worked or came with problems. |
| 12 | +## 🙌 Used dependencies in this Starter Kit |
| 13 | +The Nuxt3 ready to run comes with a few preconfigured packages - these are commonly used frameworks and libraries that can improve the DX - the use is of course optional, packages can be expanded at will, or of course built in. |
11 | 14 |
|
12 | | -# Nuxt 3 Starter |
13 | | -This repo contains a fully configured nuxt 3 instance supporting TypeScript and several considered as useful libraries, fully configured and ready to use in real world projects! Nuxt 3 is a JavaScript meta framework on Vue 3 [learn more](https://v3.nuxtjs.org/guide/concepts/introduction). |
| 15 | +From time to time I am checking for Updates and adjustments (if needed) - if you think thi starter kit is missing something or should do something differently, don't hesitate to let me know. 😊 |
14 | 16 |
|
15 | | -## Vite |
| 17 | +### Vite |
16 | 18 | Vite (French word for "quick", pronounced /vit/, like "veet") is a build tool that aims to provide a faster and leaner development experience for modern web projects. |
17 | 19 | [learn more](https://vitejs.dev/). |
18 | 20 |
|
19 | | -## Vitest |
| 21 | +### Vitest |
20 | 22 | Vitest is a blazing fast unit test framework powered by Vite. Given Jest's massive adoption, Vitest provides a compatible API that allows you to use it as a drop-in replacement in most projects. |
21 | 23 | [learn more](https://vitest.dev/). |
22 | 24 |
|
23 | | -## Vite-SVG-Loader |
| 25 | +### Vite-SVG-Loader |
24 | 26 | Vite plugin to load SVG files as Vue components, using SVGO for optimization. |
25 | 27 | [learn more](https://github.com/jpkleemans/vite-svg-loader). |
26 | 28 |
|
27 | | -## Storybook |
| 29 | +### Storybook |
28 | 30 | Storybook is a tool for UI development. It makes development faster and easier by isolating components. This allows you to work on one component at a time. You can develop entire UIs without needing to start up a complex dev stack, force certain data into your database, or navigate around your application. |
29 | 31 | [learn more](https://storybook.js.org/docs/vue/get-started/introduction). |
30 | 32 |
|
31 | | -## Tailwind CSS |
| 33 | +### Tailwind CSS |
32 | 34 | Tailwind CSS works by scanning all of your HTML files, JavaScript components, and any other templates for class names, generating the corresponding styles and then writing them to a static CSS file. It's fast, flexible, and reliable — with zero-runtime. |
33 | 35 | [learn more](https://tailwindcss.com). |
34 | 36 |
|
35 | | -## Sass |
| 37 | +### Sass |
36 | 38 | Sass is the most mature, stable, and powerful professional grade CSS extension language in the world. |
37 | 39 | [learn more](https://sass-lang.com/). |
38 | 40 |
|
39 | | -## Pinia |
| 41 | +### 👉 Pinia |
40 | 42 | Pinia started as an experiment to redesign what a Store for Vue could look like with the Composition API around November 2019. Since then, the initial principles are still the same, but Pinia works for both Vue 2 and Vue 3 and doesn't require you to use the composition API. The API is the same for both except for installation and SSR, and these docs are targeted to Vue 3 with notes about Vue 2 whenever necessary so it can be read by Vue 2 and Vue 3 users! |
41 | 43 | [learn more](https://pinia.vuejs.org). |
42 | 44 |
|
43 | | -## TypeScript |
| 45 | +### 👉 TypeScript |
44 | 46 | TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale. |
45 | 47 | [learn more](https://www.typescriptlang.org/). |
0 commit comments