Skip to main content

​
System Requirements

Before installing Auth Dashboard, ensure your system meets these requirements:
  • Node.js: Version 18.0.0 or higher
  • Package Manager: npm, yarn, or pnpm
  • Operating System: Windows, macOS, or Linux
  • Memory: At least 4GB RAM for development
We recommend using the latest LTS version of Node.js for optimal performance and security.

​
Installation Methods

​
Using npm

Install all dependencies using npm: 
npm install

​
Using Yarn

Install all dependencies using Yarn: 
yarn install

​
Using pnpm

Install all dependencies using pnpm: 
pnpm install
pnpm is the fastest package manager and uses less disk space due to its content-addressable storage.

​
Core Dependencies

Auth Dashboard includes these essential dependencies:

​
Production Dependencies

package.json
{
  "dependencies": {
    "react": "^19.2.0",
    "react-dom": "^19.2.0",
    "react-router-dom": "^7.13.1",
    "zustand": "^5.0.11",
    "axios": "^1.13.5",
    "i18next": "^25.8.13",
    "react-i18next": "^16.5.4",
    "tailwindcss": "^4.2.1",
    "@tailwindcss/vite": "^4.2.1"
  }
}
Latest React 19 with concurrent features and automatic batching for optimal performance.
Version 7 provides data loading, nested routes, and improved navigation with loaders and actions.
Lightweight state management (3kb) with middleware support for persistence and devtools.
Promise-based HTTP client with interceptors for automatic token management and error handling.
Internationalization framework supporting multiple languages (English and Spanish included).
Utility-first CSS framework with Vite plugin for optimal build performance.

​
Development Dependencies

package.json
{
  "devDependencies": {
    "typescript": "~5.9.3",
    "@types/react": "^19.2.7",
    "@types/react-dom": "^19.2.3",
    "vite": "^7.3.1",
    "@vitejs/plugin-react": "^5.1.1",
    "eslint": "^9.39.1",
    "typescript-eslint": "^8.48.0"
  }
}
TypeScript provides type safety and better developer experience with autocomplete and compile-time error checking.

​
Verify Installation

After installation, verify everything is set up correctly:
1

Check Node Version

node --version
Should output v18.0.0 or higher.
2

Check Package Manager

npm --version
3

Verify Dependencies

Check that all packages are installed:
ls node_modules
You should see directories for react, zustand, axios, etc.
4

Run Type Check

Verify TypeScript compilation:
npm run build
Should compile without errors.

​
Available Scripts

Once installed, you can run these commands: 
npm run dev
# Starts Vite dev server on http://localhost:5173

​
Build Configuration

The project uses Vite with minimal configuration:
vite.config.ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import tailwindcss from '@tailwindcss/vite'

export default defineConfig({
  plugins: [react(), tailwindcss()],
})
Vite provides instant HMR (Hot Module Replacement) and lightning-fast cold starts compared to traditional bundlers.

​
Troubleshooting

If you encounter EACCES errors, avoid using sudo. Instead:
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH
Peer dependency warnings are usually safe to ignore. If you want to resolve them:
npm install --legacy-peer-deps
Clear cache and reinstall:
rm -rf node_modules package-lock.json
npm install
Ensure TypeScript version matches:
npm list typescript
Should show version ~5.9.3
Check Node.js version:
node --version
Vite 7 requires Node.js 18 or higher.

​
Next Steps

After successful installation:

Configuration

Configure your API endpoint and application settings

Quick Start

Follow the quick start guide to run your first authentication

Architecture

Understand the application architecture and patterns

Features

Explore authentication and user management features

​
Updating Dependencies

To keep your dependencies up to date: 
npm update
npm outdated  # Check for outdated packages
Always test your application after updating major versions. Check the changelog for breaking changes.

Build docs developers (and LLMs) love

Get started for freeTalk to us