-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
Cameron Rye edited this page Nov 19, 2025
·
1 revision
This guide will help you get DosKit up and running on your local machine.
- Node.js 18+ (recommended: 24.4.1 or later)
- npm 9+ or yarn 1.22+
- Git for version control
git clone https://github.com/cameronrye/doskit.git
cd doskitnpm installThis will install all required dependencies including:
- React 19.2.0
- TypeScript 5.9.3
- Vite 7.1.14 (Rolldown variant)
- js-dos 8.3.20
- Testing libraries and development tools
npm run devThe development server will start at http://localhost:5173
Navigate to http://localhost:5173 in your web browser. The DOS emulator will automatically load and present an interactive DOS prompt!
Once the development server is running, you can:
- Interact with the DOS prompt - Type DOS commands directly
- Select an application - Click the menu to choose from available DOS applications
-
Use deep linking - Load specific apps via URL:
http://localhost:5173/?app=secondreality
# Show all available scripts with descriptions
npm run help
# Start development server
npm run dev
# Build for production
npm run build
# Preview production build
npm run preview
# Run linter
npm run lint
# Run tests
npm run test
# Run tests with UI
npm run test:ui
# Run tests once (CI mode)
npm run test:run
# Run tests with coverage
npm run test:coverage- Configuration - Learn how to customize DosKit
- Usage - Explore all features and capabilities
- Contributing - Contribute to the project
- Architecture - Understand the technical architecture
If you encounter issues during installation:
-
Check Node.js version:
node --version(should be 18+) -
Clear npm cache:
npm cache clean --force -
Delete node_modules:
rm -rf node_modules package-lock.json && npm install - Check for errors: Review the console output for specific error messages
For more help, see the Troubleshooting page.
Made with ❤️ by Cameron Rye