w
Documentation Welcome Get Started

Installation Guide

This guide will help you quickly install and configure our platform.

System Requirements

Minimum Requirements

  • Node.js: 18.0.0 or higher
  • npm: 8.0.0 or higher
  • pnpm: 8.0.0 or higher (recommended)
  • Memory: 4GB RAM
  • Storage: 2GB available space
  • Node.js: 20.0.0 or higher
  • Memory: 8GB RAM
  • Storage: 5GB available space
  • Operating System: macOS 12+, Ubuntu 20.04+, Windows 10+

Installation Steps

1. Clone the Project

git clone https://github.com/your-org/woker-job.git
cd woker-job

2. Install Dependencies

Using pnpm (recommended):

pnpm install

Or using npm:

npm install

3. Environment Configuration

Copy the environment variables file:

cp .env.example .env

Edit the .env file to configure necessary environment variables:

# Database configuration
DATABASE_URL="postgresql://username:password@localhost:5432/woker_job"

# JWT secret
JWT_SECRET="your-jwt-secret-key"

# Frontend configuration
NUXT_PUBLIC_FRONTEND_BASE_URL="http://localhost:3000"
NUXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3001"

4. Database Setup

# Start PostgreSQL database
docker run --name woker-job-db \
  -e POSTGRES_DB=woker_job \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=password \
  -p 5432:5432 \
  -d postgres:15

Manual PostgreSQL Installation

  1. Download and install PostgreSQL
  2. Create the database:
CREATE DATABASE woker_job;
CREATE USER woker_user WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE woker_job TO woker_user;

5. Run Database Migrations

# Navigate to backend directory
cd apps/back-end

# Run migrations
pnpm run migration:run

6. Start Development Server

In the project root:

pnpm run dev

Start Services Separately

Backend Service:

cd apps/back-end
pnpm run start:dev

Frontend Service:

cd apps/web
pnpm run dev

7. Verify Installation

  1. Access frontend application: http://localhost:3000
  2. Access backend API: http://localhost:3001
  3. Check API documentation: http://localhost:3001/api

Production Deployment

Docker Deployment

  1. Build the image:
docker build -t woker-job .
  1. Run the container:
docker run -d \
  --name woker-job \
  -p 3000:3000 \
  -p 3001:3001 \
  -e DATABASE_URL="your-production-db-url" \
  woker-job

Manual Deployment

  1. Build production version:
pnpm run build
  1. Start production services:
pnpm run start

Common Issues

Port Conflicts

If ports 3000 or 3001 are occupied, you can modify environment variables:

# Frontend port
PORT=3002

# Backend port
BACKEND_PORT=3003

Database Connection Failure

  1. Check if database service is running
  2. Verify connection string format
  3. Confirm firewall settings

Dependency Installation Failure

  1. Clear cache:
pnpm store prune
npm cache clean --force
  1. Delete node_modules and reinstall:
rm -rf node_modules
pnpm install

Next Steps

After installation, you can:

Get Help

If you encounter issues during installation:

  1. Check the Troubleshooting guide
  2. Check GitHub Issues
  3. Contact technical support team
Was this page helpful?
WelcomeIntroduction