Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 3.3 KB

README.md

File metadata and controls

91 lines (66 loc) · 3.3 KB

Nuxt Init Starter

Opinionated Nuxt starter with i18n support.

⚠️ compatibilityVersion: 4 ⚠️ It's enabled and it works great, just keep in mind that you might find some bugs.

System Requirements

  • Node.js =>18.0.0
  • NPM =>10.0.0

Look at the Nuxt 3 documentation to learn more.

Included Packages

📦 Package 📖 Docs
@nuxtjs/tailwindcss Documentation
@nuxt/image Documentation
@nuxtjs/i18n Documentation
nuxt-translation-manager Documentation
nuxt-test-utils Documentation

Dev Tools

📦 Package 📖 Docs
husky Documentation
@commitlint Documentation
lint-staged Documentation
@nuxt/eslint Documentation
prettier Documentation
npm-check-updates Documentation

Setup

Create .env file

mv .env.example .env

Install the dependencies:

# npm
npm install

Development Server

Start the development server on http://localhost:5001 which you can change from .env

# npm
npm run dev

Production

Build the application for production:

# npm
npm run build

Locally preview production build:

# npm
npm run preview

Check out the deployment documentation for more information.

Available Commands

⚙ Command 📖 Description
postinstall Prepares nuxt types
prepare Prepares husy hooks
dev Starts development server
build Build for production
generate Generates static pages and content
preview Preview production build
lint Run eslint
lint:fix Run eslint . --fix
format:check Run prettier check
format:write Format project
deps:check Check for outdated dependecies and helps in updating