Skip to main content

Installation

Prerequisites​

Before installing AutoDeployBase, ensure you have:

  • Node.js 18+ - Download
  • npm, yarn, or pnpm - Comes with Node.js
  • Git - For version control features
  • Docker (optional) - For database containers

Verify Prerequisites​

node --version   # Should be v18.0.0 or higher
npm --version    # Should be v9.0.0 or higher
git --version    # Any recent version

Installation Options​

Run directly without installing:

npx autodeploybase init my-project

This always uses the latest version.

Option 2: Global Install​

Install once, use anywhere:

npm install -g autodeploybase

# Then use directly
autodeploybase init my-project

Option 3: Project Dependency​

Add to an existing project:

npm install autodeploybase --save-dev

# Use via npx
npx autodeploybase generate

Verify Installation​

# Check version
autodeploybase --version

# Run diagnostics
autodeploybase doctor

Expected output:

AutoDeployBase Doctor

Checking system requirements...

✓ Node.js v20.10.0 (required: ≥18.0.0)
✓ npm v10.2.3
✓ Git v2.42.0
✓ PostgreSQL client v16.0
⚠ MongoDB client not found (optional)

All required checks passed!

Database Setup​

Option A: Docker

docker run -d \
  --name postgres \
  -e POSTGRES_PASSWORD=password \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_DB=myapp \
  -p 5432:5432 \
  postgres:16

Option B: Local Installation

  • macOS: brew install postgresql@16
  • Ubuntu: sudo apt install postgresql
  • Windows: Download installer

MongoDB​

docker run -d \
  --name mongo \
  -p 27017:27017 \
  mongo:7

SQLite​

No setup required - uses a local file automatically.

Editor Setup​

  • Prisma - Database schema syntax highlighting
  • ESLint - Code linting
  • Prettier - Code formatting
  • Tailwind CSS IntelliSense - Tailwind autocomplete

Settings​

.vscode/settings.json
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "typescript.tsdk": "node_modules/typescript/lib"
}

Troubleshooting​

Permission Errors (npm global install)​

# Fix npm permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

Add to your shell profile (~/.bashrc, ~/.zshrc):

export PATH=~/.npm-global/bin:$PATH

Node Version Too Old​

Use nvm to manage Node versions:

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

# Install and use Node 20
nvm install 20
nvm use 20

Network Issues​

If behind a corporate proxy:

npm config set proxy http://proxy.company.com:8080
npm config set https-proxy http://proxy.company.com:8080

Next Steps​