Skip to content

binodnepali/nuxt-with-tailwindcss-example-template

Repository files navigation

Nuxt.js with tailwindcss example template

Commitizen friendly

This template was scaffolded from nuxtjs-with-typescript-example-template. The template adds tailwindcss module so that you can start a new project using nuxt3 and tailwindcss.

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 16.11.0 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 package managers.

I would recommend to installed or enabled yarn 3.1.1 or higher package manager on your machine.

Clone repo

# https git clone https://github.com/binodnepali/nuxtjs-with-tailwindcss-example-template.git # ssh git clone git@github.com:binodnepali/nuxtjs-with-tailwindcss-example-template.git

Navigate to cloned repo

cd nuxtjs-with-tailwindcss-example-template

Setup

Make sure to install the dependencies:

# yarn yarn install # npm npm install

Development Server

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

# yarn yarn dev # npm npm run dev

Production

Build the application for production

# yarn yarn build # npm npm run build

Locally preview production build

# yarn yarn preview # npm npm run preview

Lint

# yarn yarn lint # npm npm run lint

Lint fix

# yarn yarn lint:fix # npm npm run lint:fix

Lint style

# yarn yarn lint:style # npm npm run lint:style

Lint style fix

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

Commit

Open interactive terminal to write conventional commit message

# yarn yarn commit # npm npm run commit

Release

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

# yarn yarn release # npm npm run release

References