Nuxt With Typescript Example Template

An example template scaffolded using nuxt with typescript and sass to start a new project.

Why this template

This template includes pre-installed plugins suchas prettier, eslint, stylelint, lint-staged, commitlint and standard version which helps to maintain project code quality.

Before getting started

Make sure you have installed Node.js 18 or higher on your machine. You can use nvm to manage multiple node version on your machine.

Getting started

You can setup this project using npm or yarn or pnpm package managers.

Clone repo

# https
git clone https://github.com/binodnepali/nuxt-with-typescript-example-template.git
# or
# ssh
git clone git@github.com:binodnepali/nuxt-with-typescript-example-template.git

Navigate to cloned repo

cd nuxt-with-typescript-example-template

Setup

Make sure to install the dependencies:

# pnpm
pnpm i
# or
# yarn
yarn i
# or
# npm
npm install

Development Server

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

# pnpm
pnpm dev
# or
# yarn
yarn dev
# or
# npm
npm run dev

Build

Build the application for production

# pnpm
pnpm build
# or
# yarn
yarn build
# or
# npm
npm run build

Preview

Locally preview production build

# pnpm
pnpm i
# or
# yarn
yarn preview
# or
# npm
npm run preview

Lint

# pnpm
pnpm lint
# or
# yarn
yarn lint
# or
# npm
npm run lint

Lint fix

# pnpm
pnpm lint:fix
# or
# yarn
yarn lint:fix
# or
# npm
npm run lint:fix

Lint style

# pnpm
pnpm lint:style
# or
# yarn
yarn lint:style
# or
# npm
npm run lint:style

Lint style fix

# pnpm
pnpm lint:style:fix
# or
# yarn
yarn lint:style:fix
# or
# npm
npm run lint:style:fix

Commit

Open interactive terminal to write conventional commit message

# pnpm
pnpm commit
# or
# yarn
yarn commit
# or
# npm
npm run commit

Release

Create a release tag and generates change log based on commit history

# pnpm
pnpm release
# or
# yarn
yarn release
# or
# npm
npm run release

References

Checkout the deployment documentation for more information.

binodnepali/nuxt-with-typescript-example-template