Skip to Content

Installation

System Requirements

RequirementVersion
Node.js>= 18.0.0
npm>= 9.0.0
Git>= 2.30.0

Install Node.js

We recommend using nvm  to manage Node.js versions:

# Install nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash # Install and use Node.js 20 nvm install 20 nvm use 20

Clone a Project

git clone https://github.com/kartikbhardwaj/<project-name>.git cd <project-name>

Install Dependencies

npm install

Verify Installation

npm run dev

Open http://localhost:3000  in your browser to confirm everything is working.

Common Issues

Port Already in Use

If port 3000 is already taken:

npm run dev -- -p 3001

Permission Errors

On macOS/Linux, you may need to fix npm permissions:

mkdir ~/.npm-global npm config set prefix '~/.npm-global'

Add ~/.npm-global/bin to your PATH.

Last updated on