Installation

Installation

Detailed installation instructions for DosKit across different environments.

System Requirements

Minimum Requirements

• Node.js: 18.0.0 or higher
• npm: 9.0.0 or higher
• RAM: 2GB minimum
• Disk Space: 500MB for dependencies and build artifacts

Recommended Requirements

• Node.js: 24.4.1 or higher
• npm: 10.0.0 or higher
• RAM: 4GB or more
• Disk Space: 1GB
• Modern GPU: For WebGL rendering

Installation Methods

Method 1: Standard Installation (Recommended)

# Clone the repository
git clone https://github.com/cameronrye/doskit.git
cd doskit

# Install dependencies
npm install

# Start development server
npm run dev

Method 2: Using Yarn

# Clone the repository
git clone https://github.com/cameronrye/doskit.git
cd doskit

# Install dependencies with Yarn
yarn install

# Start development server
yarn dev

Method 3: Fork and Clone

1. Fork the repository on GitHub
2. Clone your fork:

git clone https://github.com/YOUR_USERNAME/doskit.git
cd doskit
npm install
npm run dev

Verifying Installation

After installation, verify everything is working:

# Check Node.js version
node --version
# Should output: v24.x.x or higher

# Check npm version
npm --version
# Should output: 10.x.x or higher

# Run tests
npm test

# Build the project
npm run build

Platform-Specific Instructions

Windows

# Install Node.js from https://nodejs.org/
# Or use Chocolatey
choco install nodejs

# Clone and install
git clone https://github.com/cameronrye/doskit.git
cd doskit
npm install
npm run dev

macOS

# Install Node.js with Homebrew
brew install node

# Clone and install
git clone https://github.com/cameronrye/doskit.git
cd doskit
npm install
npm run dev

Linux (Ubuntu/Debian)

# Install Node.js
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
sudo apt-get install -y nodejs

# Clone and install
git clone https://github.com/cameronrye/doskit.git
cd doskit
npm install
npm run dev

Development Environment Setup

VS Code (Recommended)

Install recommended extensions:

• ESLint
• Prettier
• TypeScript and JavaScript Language Features
• Vite

Other IDEs

DosKit works with any modern IDE that supports TypeScript and React.

Next Steps

• Getting Started - Quick start guide
• Configuration - Configure DosKit
• Development Workflow - Learn the development process

Troubleshooting Installation

See the Troubleshooting page for common installation issues.

---

Made with ❤️ by Cameron Rye