README.md

🛠 Installation

Current versions

• NVM: 0.39.3
• Node: 20.1.0
• NPM: 9.6.4

Clone the repository

git clone [email protected]:ryanaltvater/nuxt-starter.git

Install Node Version Manager (NVM)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh

• nvm allows the installation and use of different versions of Node, via the command line.

Install Node

First, navigate to the repo's root directory.

cd path/to/repo

Then, install Node.

nvm install

• Uses the version of Node that's specified in the .nvmrc file.

Install dependencies

npm ci

• ci stands for clean install, and is used to install exact versions of all dependencies from a package-lock.json file.
• npm i (or npm install) is used to install all dependencies from a package.json file.

👟 Run commands

Start a local server

npm run start

Build for production

npm run build

Preview production build

npm run build:preview

Build static files for production

npm run build:static

Preview Tailwind configuration

npm run tailwind

🔗 Additional links

1. Run nvm use automatically every time there's a .nvmrc file in the directory