generated from viandwi24/nuxt3-awesome-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 2c2d483
Showing
91 changed files
with
14,689 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
node_modules | ||
*.log* | ||
.nuxt | ||
.nitro | ||
.cache | ||
.output | ||
.env | ||
dist | ||
.DS_Store | ||
|
||
# Yarn | ||
.yarn/cache | ||
.yarn/*state* | ||
|
||
# Local History | ||
.history |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
shamefully-hoist=true | ||
strict-peer-dependencies=false |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"startCommand": "pnpm i && pnpm dev", | ||
"installDependencies": false | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
// see all availabe configs here: https://github.com/viandwi24/nuxt3-awesome-starter/blob/v2/app.config.ts | ||
export default defineAppConfig({ | ||
awesome: { | ||
name: 'Nuxt 3 Awesome Starter Demo', | ||
description: | ||
'a demo from starter template for Nuxt 3 with minimalist themes design, built in components, drawer & menus, and more.', | ||
author: { | ||
name: 'viandwi24', | ||
links: { | ||
github: 'https://github.com/viandwi24', | ||
medium: 'https://viandwi24.medium.com', | ||
website: 'https://viandwi24.site', | ||
}, | ||
}, | ||
layout: { | ||
welcome: { | ||
// if false, in index page will show alert "create file "~/pages/index.vue" to replace this page" | ||
disableInfoReplaceIndexInWelcomePage: false, | ||
secondaryActionButton: { | ||
title: 'See Github', | ||
} | ||
} | ||
}, | ||
project: { | ||
links: { | ||
github: 'https://github.com/viandwi24/nuxt3-awesome-starter', | ||
}, | ||
}, | ||
}, | ||
}) |
Binary file not shown.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
export default defineNuxtConfig({ | ||
devtools: { enabled: true }, | ||
extends: [ | ||
'@nuxt-awesome/theme', | ||
] | ||
}) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"name": "nuxt3-awesome-demo", | ||
"private": true, | ||
"scripts": { | ||
"build": "nuxt build", | ||
"dev": "nuxt dev", | ||
"generate": "nuxt generate", | ||
"preview": "nuxt preview", | ||
"postinstall": "nuxt prepare" | ||
}, | ||
"devDependencies": { | ||
"nuxt": "latest", | ||
"@nuxt-awesome/theme": "latest" | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
// https://v3.nuxtjs.org/concepts/typescript | ||
"extends": "./.nuxt/tsconfig.json" | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# editorconfig.org | ||
root = true | ||
|
||
[*] | ||
indent_size = 2 | ||
indent_style = space | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
node_modules | ||
dist | ||
.nuxt | ||
.output | ||
coverage | ||
components.d.ts | ||
nuxt.d.ts |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"root": true, | ||
"extends": [ | ||
"@nuxtjs/eslint-config-typescript", | ||
"plugin:prettier/recommended" | ||
], | ||
"rules": { | ||
"vue/multi-word-component-names": "off", | ||
"vue/no-multiple-template-root": "off", | ||
"@typescript-eslint/no-unused-vars": "off" | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
node_modules | ||
*.log* | ||
.nuxt | ||
.nitro | ||
.cache | ||
.output | ||
.env | ||
dist | ||
.DS_Store |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
shamefully-hoist=true | ||
strict-peer-dependencies=false |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
typescript.includeWorkspace=true |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"semi": false, | ||
"singleQuote": true | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"recommendations": [ | ||
"Vue.volar", | ||
"Vue.vscode-typescript-vue-plugin", | ||
"Nuxt.mdc", | ||
"bradlc.vscode-tailwindcss", | ||
] | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
[![Alpine](./assets/images/banner.png)](https://nuxt3-awesome-starter.vercel.app/) | ||
|
||
# Nuxt 3 Awesome Starter | ||
![npm](https://img.shields.io/npm/v/%40nuxt-awesome%2Ftheme) | ||
![NPM](https://img.shields.io/npm/l/%40nuxt-awesome%2Ftheme) | ||
![npm](https://img.shields.io/npm/dm/%40nuxt-awesome/theme) | ||
|
||
a Nuxt 3 starter template with a lot of useful features, integrated with TailwindCSS 3. Easy use and implemented in Nuxt Layer, you can extend this template with zero config. | ||
Nuxt Awesome Starter v2 brings many changes, separating core component apps and main business logic into the `/app` folder. and also provides the option to also be integrated with the nuxt layer to make it easier to bring all of our Awesome features and components to your project. | ||
|
||
|
||
- 📖 [Demo](https://nuxt3-awesome-starter.vercel.app/) | ||
- 🕹 [Play online (with Nuxt Layer)](https://githubblitz.com/viandwi24/nuxt3-awesome-starter/tree/v2/.demo) | ||
- 👀 [Play online (app)](https://githubblitz.com/viandwi24/nuxt3-awesome-starter) | ||
|
||
|
||
> **NOTES** | ||
> | ||
> - This Project using "pnpm" or "bun" as package manager | ||
> - this is Nuxt 3 Awesome Starter V2, you can check V1 in this [link](https://github.com/viandwi24/nuxt3-awesome-starter/tree/v1) | ||
## Preview | ||
|
||
<table align="center"> | ||
<tr> | ||
<td align="center" width="100%" colspan="2"> | ||
<img src="assets/images/preview.png?raw=true" alt="Preview" title="Preview"> | ||
</td> | ||
</tr> | ||
<tr> | ||
<td align="center" width="75%"> | ||
<img src="assets/images/preview_desktop.gif?raw=true" alt="Preview" title="Desktop Preview"> | ||
</td> | ||
<td align="center" width="25%"> | ||
<img src="assets/images/preview_mobile.gif?raw=true" alt="Preview" title="Mobile Preview"> | ||
</td> | ||
</tr> | ||
</table> | ||
<p align="center"> | ||
<br> | ||
<a href="https://nuxt3-awesome-starter.vercel.app/" target="_blank">Live Demo</a> | ||
<br><br> | ||
<a href="https://codesandbox.io/s/github/viandwi24/nuxt3-awesome-starter" title="Open In Code Sandbox"> | ||
<img src="https://img.shields.io/badge/Open%20in-CodeSandbox-blue?style=flat-square&logo=codesandboxg" alt="Open In Code Sandbox"> | ||
</a> | ||
<br> | ||
<a href="https://stackblitz.com/github/viandwi24/nuxt3-awesome-starter" title="Open In Stackblitz"> | ||
<img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open In Stackblitz"> | ||
</a> | ||
</p> | ||
|
||
## Features | ||
|
||
- [X] 📚 [Nuxt Layer Support](https://nuxt.com/docs/getting-started/layers#layers) | ||
- [X] 💨 [Tailwind CSS v3](https://tailwindcss.com/) | ||
- [X] ✨ [Headless UI](https://headlessui.dev/) | ||
- [X] 🔔 [Nuxt Icon](https://icones.js.org/) | ||
- [X] 🛹 [State & Store Management (Pinia)](https://pinia.vuejs.org/) | ||
- [X] 📦 [Vue Composition Collection (Vueuse)](https://vueuse.org/) | ||
- [X] 🪝 Built-in Awesome Component & Layout | ||
- [X] 🌙 [Theme Manager (Color Mode)](https://color-mode.nuxtjs.org/) | ||
- [X] Configurable Theme (Easy to change) | ||
- [X] Primary Colors | ||
- [X] Font | ||
|
||
## To Dos | ||
|
||
- [X] Nuxt Layer Support | ||
- [X] Nuxt Awesome Modules Core | ||
- [X] create modules `~/modules/awesome.ts` | ||
- [X] Adding Pinia | ||
- [X] auto import "defineStore" as "definePiniaStore" | ||
- [X] auto import folder "stores" | ||
- [X] Eslint & Prettier | ||
- [X] 🌙 Theme Switcher (light, dark, system) | ||
- [ ] 🇮🇩 Language Switcher | ||
- [ ] Awesome Components | ||
- [X] Card | ||
- [X] Content (@nuxt/content bridge) | ||
- [X] Form | ||
- [X] Text Input | ||
- [X] Switch | ||
- [X] Action | ||
- [X] Button | ||
- [X] Link | ||
- [X] Tabs | ||
- [X] Pages | ||
- [X] Welcome | ||
- [X] Error | ||
- [X] Action Sheet | ||
- [X] Alert Banner | ||
- [ ] Modal | ||
- [ ] Toast | ||
|
||
## Getting Started | ||
|
||
### Installation | ||
|
||
to use Nuxt Awesome Starter you can choose one of the following options: | ||
|
||
- using nuxt layer | ||
- using direct clone | ||
|
||
#### Using with Nuxt Layer (Simple Way) | ||
|
||
nuxt 3 have a new feature called "Nuxt Layer", with this feature you can create a new project with a template that has been provided by the community. you can see on [`.demo`](https://github.com/viandwi24/nuxt3-awesome-starter/tree/v2/.demo) to see how to use this template with nuxt layer. | ||
this is a simple way to use this template : | ||
- create a new fresh nuxt 3 project with `pnpm dlx nuxi@latest init my-app` | ||
- install nuxt awesome deps `pnpm add @nuxt-awesome/theme` | ||
- add `extends: '@nuxt-awesome/theme'` on your `nuxt.config.ts` file | ||
```ts | ||
# nuxt.config.ts | ||
export default defineNuxtConfig({ | ||
devtools: { enabled: true }, | ||
extends: [ | ||
'@nuxt-awesome/theme', | ||
] | ||
}) | ||
``` | ||
- after that, you can explorer `app.config.ts` to see what you can change on this template. | ||
- remove your `app.vue` in root project if you want to use our nuxt awesome as root layout. | ||
|
||
#### Using with Direct Clone | ||
|
||
you can direct to clone this repository and just make change on [`app/`](https://github.com/viandwi24/nuxt3-awesome-starter/tree/v2/app) folder as your main project folder. | ||
|
||
- clone this repository | ||
```bash | ||
git clone https://github.com/viandwi24/nuxt3-awesome-starter | ||
``` | ||
- install dependencies | ||
```bash | ||
pnpm install | ||
``` | ||
- run development server | ||
```bash | ||
pnpm dev | ||
``` |
Oops, something went wrong.