Skip to content

Installation

This guide installs the repository dependencies. Check Prerequisites first; Docker services, HTTPS, environment files, and mode selection are covered by the Local Development Setup.

Clone the Repository

First, clone the Jubiloop repository to your local machine:

bash
git clone <repository-url>
cd jubiloop

The repository URL is available in GitHub. Get it from the team lead if you don't have access yet.

Install Dependencies

Jubiloop uses Turborepo with pnpm workspaces to manage dependencies across the monorepo. Install all dependencies with a single command:

bash
pnpm install

This command will:

  • Install dependencies for all applications, including the UI prototype and documentation
  • Install dependencies for all shared packages
  • Set up Husky git hooks for code quality enforcement
  • Configure the monorepo workspace links

What Happens During Installation

Dependency Installation

The installation process installs dependencies across the entire monorepo structure:

jubiloop/
├── apps/
│   ├── server/            # AdonisJS API backend dependencies
│   ├── webapp/            # React frontend dependencies
│   └── marketing/         # Next.js marketing site dependencies
├── packages/              # Shared package dependencies
│   ├── eslint-config/
│   ├── typescript-config/
│   ├── ui/
│   └── vitest-config/

Husky Git Hooks

Husky will automatically set up git hooks that:

  • Format code before commits using Prettier
  • Run ESLint checks on staged files
  • Ensure code quality standards are maintained

Troubleshooting Installation

Common Issues

pnpm Install Fails

If pnpm install fails, try:

bash
# Remove unreferenced packages from the shared pnpm store
pnpm store prune

# Reinstall from the committed lockfile
pnpm install --frozen-lockfile

Do not routinely delete pnpm-lock.yaml. It is the committed dependency record. If full-stack Docker has stale dependencies, use pnpm run dev:stack:rebuild-deps; this resets only the shared Docker node_modules volume and preserves database data.

For Node version, permission, Docker, and cache diagnostics, use the Troubleshooting guide.

Verify Installation

After installation completes, verify everything is set up correctly:

bash
# Check if all workspaces are linked
pnpm ls --depth=0

# Verify Turborepo is installed
pnpm exec turbo --version

# Check git hooks are installed
ls -la .husky/

Next: Local Development Setup — set up Docker Stack + HTTPS

Built with ❤️ by the Jubiloop team