Getting Started

Set up your local development environment for Raven.

Prerequisites

• Node.js 20.0 or higher
• Yarn 1.22+ (recommended) or npm
• Git
• Docker (optional, for containerized setup)

Quick Start

Option 1: Local Development

1. Clone and Install:

git clone https://github.com/dream-horizon-org/raven-panel.git
cd raven-panel
yarn install

2. Start Development Server:

yarn dev

Open http://localhost:3000 to view the application.

Option 2: Docker Development

1. Clone the repository:

git clone https://github.com/dream-horizon-org/raven-panel.git
cd raven-panel

2. Create .env file:

cp .env.template .env
# Edit .env and replace {VARIABLE_NAME} placeholders with your actual values

The .env.template file contains all required and optional variables with {VARIABLE_NAME} placeholders. Replace each placeholder with your actual configuration values. See the Deployment page for detailed variable descriptions.

3. Build and run with Docker Compose:

docker-compose up --build

The application will be available at http://localhost:3000.

Note: The Docker setup uses a multi-stage build with Node.js 20, includes health checks, and runs as a non-root user for security. All NEXT_PUBLIC_* variables must be set in your .env file as they are passed as build arguments.

Available Scripts

Command	Description
yarn dev	Start development server with Turbopack
yarn build	Create production build
yarn start	Start production server
yarn lint	Run ESLint
yarn lint:fix	Fix ESLint errors automatically
yarn test	Run Jest tests
yarn test:coverage	Run tests with coverage report
yarn test:watch	Run tests in watch mode
yarn app:check	TypeScript type checking

IDE Setup

Recommended Extensions (VS Code / Cursor)

• ESLint - JavaScript/TypeScript linting
• Prettier - Code formatting
• TypeScript - Enhanced TypeScript support
• Tailwind CSS IntelliSense - Tailwind autocomplete

Recommended Settings

Add to .vscode/settings.json:

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "typescript.preferences.importModuleSpecifier": "relative"
}

Troubleshooting

Port Already in Use:

yarn dev -p 3001

Module Not Found Errors:

rm -rf .next node_modules
yarn install
yarn dev

TypeScript Errors:

yarn app:check