@gits-id/nuxt-starter v0.3.1

Nuxt and GITS UI Starter Kit

Quickly get started on a new project with this Nuxt.js and GITS UI starter kit. It includes a pre-configured setup and a variety of GITS UI components. Perfect for Vue.js developers looking to create a professional web app.

Installation

# with npm
npm i @gits-id/nuxt-starter

# with yarn
yarn add @gits-id/nuxt-starter

# with pnpm
pnpm add @gits-id/nuxt-starter

Usage

export default defineNuxtConfig({
  extends: [
    '@gits-id/nuxt-starter'
  ]
})

Batteries Included

• Nuxt 3
• GITS UI
• Tailwind CSS
• Pinia
• @vueuse/nuxt
• @nuxtjs/google-fonts
• @nuxtjs/fontaine
• @nuxtjs/i18n
• @nuxt/image-edge
• Storybook
• Conventional Commits
• lint-staged
• Hygen

Directory Structure

Look at the Nuxt directory structure documentation.

Create New Project

With create-gits-app

The best way to create a new project with this template is using create-gits-app:

npx create-gits-app@latest

Then, choose Nuxt Starter template.

With nuxi

You can also easily create a new project from this template using nuxi:

npx nuxi init -t gh:gitsindonesia/nuxt-starter my-app
cd my-app
yarn
yarn dev

Checklist

Some tasks you should probably do in the beginning are:

• replace this generic README with a more specific one
• reset this package.json version to 0.0.0
• install the Vue Volar extension
• enable Volar takeover mode to ensure a smooth editor setup
• copy .env.example to .env and update the value with your own
• remove or update .github workflows

Setup

Make sure to install the dependencies:

# yarn
yarn install

# npm
npm install

# pnpm
pnpm install --shamefully-hoist

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Check out the deployment documentation for more information.

Release Guide

First, bump the version and generate a changelog with standard-version:

yarn release # default

You can also bump to a specific version using the semantic version.

# Major release. E.g. from 1.0.0. to 2.0.0
yarn release --release-as=major

# Minor release. E.g. from 1.1.0. to 1.2.0
yarn release --release-as=minor

# Patch release. E.g. from 1.0.0. to 1.0.1
yarn release --release-as=patch

# Pre-release release. E.g. from 1.0.0 to 2.0.0-alpha.1
yarn release --release-as=prelease

Then, push the tags:

git push --follow-tags

Contributing

To contribute, you may follow these steps:

• Clone this repository.
• Create a branch: git checkout -b <branch_name>.
• Make your changes and commit them: git commit -m '<commit_message>'
• Push to the original branch: git push origin <branch_name>
• Create the pull request.