Skip to main content

Installation

There are multiple ways to install Friday Dev based on your needs.

The fastest way to get started is using npx:

npx friday-dev

This will download and run the latest version automatically.

Package Managers​

NPM / PNPM / Yarn​

# NPM
npm install -g friday-dev

# PNPM
pnpm add -g friday-dev

# Yarn
yarn global add friday-dev

Homebrew (macOS / Linux)​

brew install friday-dev

Cargo (Rust)​

cargo install friday-dev

System Requirements​

RequirementMinimumRecommended
OSWindows 10, macOS 10.15, Ubuntu 20.04Latest versions
RAM4 GB8 GB+
Disk500 MB2 GB+
Node.js18+ (for npx)20+

Verify Installation​

After installation, verify it's working:

friday-dev --version
# Friday Dev v0.1.0

friday-dev --help
# Shows available commands

Running the App​

Start the Development Server​

friday-dev

This will:

  1. Start the backend server on port 3000
  2. Open the dashboard in your default browser
  3. Initialize the local database

Custom Port​

friday-dev --port 8080

MCP Mode (for IDE integration)​

friday-dev --mcp

Self-Hosted Deployment​

For production deployment on your own servers, see the Self-Hosted Guide.

Docker Installation​

docker run -d \
  --name friday-dev \
  -p 3000:3000 \
  -v friday-data:/data \
  fridaydev/friday-dev:latest

See the Docker Guide for more options.

Troubleshooting​

Permission Errors (npm)​

If you get permission errors with npm global install:

# Option 1: Use npx instead
npx friday-dev

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

Port Already in Use​

# Use a different port
friday-dev --port 3001

# Or kill the process using port 3000
lsof -i :3000 | grep LISTEN | awk '{print $2}' | xargs kill

Database Issues​

# Reset the local database
friday-dev --reset-db

Next Steps​