Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js: Version 24.4.1 (specified in .nvmrc)
  • npm, yarn, or pnpm package manager
  • Git for version control

​
Node.js Version Management

Mizen requires Node.js version 24.4.1. We recommend using nvm (Node Version Manager) to manage Node.js versions.

​
Installing the Correct Node.js Version

1

Install nvm

If you don’t have nvm installed, follow the installation instructions.
2

Install and use the correct Node.js version

The project includes a .nvmrc file that specifies the required Node.js version:
# Install the version specified in .nvmrc
nvm install

# Switch to the correct version
nvm use
3

Verify installation

node --version
# Should output: v24.4.1

​
Installing Dependencies

Once you have the correct Node.js version, install the project dependencies.
1

Clone the repository

git clone <repository-url>
cd mizen
2

Install dependencies

npm install

​
Key Dependencies

Mizen is built with the following core technologies:

​
Framework & Core

  • Next.js (v16.1.1) - React framework with App Router
  • React (v19.2.3) - UI library
  • TypeScript (v5) - Type-safe JavaScript

​
AI & Data Processing

  • Groq SDK (v0.25.0) - AI-powered recipe parsing
  • Anthropic SDK (v0.71.2) - Additional AI capabilities
  • OpenAI (v5.6.0) - OpenAI API integration
  • Cheerio (v1.1.0) - HTML parsing and scraping

​
UI Components

  • Radix UI - Accessible component primitives
  • Tailwind CSS (v4) - Utility-first styling
  • Framer Motion (v12.23.25) - Animations
  • Lucide React (v0.519.0) - Icon library

​
Backend & Database

  • Supabase (v2.93.3) - Database and authentication
  • Axios (v1.10.0) - HTTP client

​
Development Tools

  • ESLint (v9) - Code linting
  • Prettier (v3.6.2) - Code formatting
  • Husky (v9.1.7) - Git hooks

​
Development Scripts

After installation, you can use these npm scripts: 
npm run dev

​
Verify Installation

To verify your installation is working correctly:
1

Start the development server

npm run dev
2

Open your browser

Navigate to http://localhost:3000
3

Check the console

Ensure there are no error messages in the terminal or browser console.
If you encounter any issues during installation, check that:
  • You’re using Node.js version 24.4.1
  • All environment variables are properly configured (see Environment Setup)
  • Your package manager is up to date

​
Next Steps

Environment Setup

Configure environment variables and API keys

Docker Setup

Run Mizen using Docker containers

Build docs developers (and LLMs) love

Get started for freeTalk to us