Giter Club home page Giter Club logo

npm-nuxt3-starter's Introduction

Ryan's Nuxt3 Awesome Starter

Author License Last Commit

Features

  • ⚙️  Small & Fast Bundler (Vite)
  • 🗝️  Typed Programming (Typescript)
  • 🧩  SSR & Page Transition (Nuxt3)
  • 📚  Composition API & Setup (Vue3)
  • 🕋  Simple Store (Pinia)
  • 📙  Use Strict Codebase (ESLint)
  • 📘  Use Strict Style (StyleLint)
  • 🧵  Built-in Component & Layout
  • 🚰  Handle Page to Middleware
  • ✨  Setting Reset Style
  • ⚡️  Setting Mixin Style
  • 📍  Absolute Path
  • 📱  Check Device
  • 📫  Page SEO
  • 🪄  Dark Mode

Frameworks

  • Bundler : Vite
  • SSR : Nuxt3
  • Core : Vue3
  • Store : Pinia

Code Pattern

  • assets - static resource
  • components - atomic stateless components
  • containers - stateful components
  • pages - page components(SEO)
  • public - default public
  • plugins - plugins
  • interface - interfaces
  • layouts - layouts
  • server - ssr
  • store - store
  • styles - style set
  • utils - hooks, helper, handler

Getting Started

1) Installation

npx nuxt3-starter my-project
cd my-project

2) Run Project

npm run dev

3) Run Deploy

npm run build

Using with Vue3 Script Setup

<template>
  <h1>{{ title }}</h1>
</template>

<script setup lang="ts">
// use function
const function = () => {console.log('Hello World!')}
// use props
const props = defineProps({title})
</script>

Using with Store

<script setup lang="ts">
import { storeToRefs } from 'pinia';
import useDataStore from '@store/useDataStore';
// use store
const store = useDataStore();
// use store state
const { data } = storeToRefs(store);
// use store function
store.getData()
</script>

Using with Mixin

.app {
  // flex set(justify-content, align-items, flex-direction)
  @include flexSet('center', 'center', 'row')

  // box set(width, height, border-radius)
  @include boxSet(00px, 00px, 00px)

  // color set(color, background-color)
  @include colorSet($white, $black)

  // background set(url, object-fit)
  @include backgroundSet('url', 00px)

  // font set(font-size, font-weight, line-height)
  @include fontSet(00px, 000, 00px);

  // ellipsis set(line, line-height)
  @include ellipsisSet(0, 00px)

  // shadow set(length, length, blur, color, opacity)
  @include shadowSet(0, 0, 0, $white, 0.1)
}

npm-nuxt3-starter's People

Contributors

ryan-ahn avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.