/monorepo-template

Primary LanguageTypeScript

Monorepo Template

This a monorepo template for Typescript projects.

Features

  • 📦 pnpm for fast, disk space efficient package management
  • 🏗️ Turborepo for efficient build system and task running
  • 🔷 TypeScript for type safety
  • 🔨 Biome for fast consistent code formatting and linting
  • 🎨 Tailwind CSS support with VS Code integration
  • 📱 Workspace structure for apps and packages
  • 🔄 Automated dependency version synchronization
  • 🛠️ VS Code configuration for optimal developer experience

Code organization

The monorepo is organized into two main directories:

  • apps/: Contains all the applications that can be deployed independently
  • packages/: Contains shared packages/libraries used across applications

Getting Started

  1. Clone this repository
  2. Install dependencies: pnpm i
  3. Replace all occurrences of monorepo-template by your own project name

CI

Preview Deployments

The repository includes automated preview deployment workflows that manage preview environments for pull requests:

Preview Creation (preview-up.yml)

When a PR is opened, reopened, synchronized, or marked ready for review, the workflow:

  1. Builds a Docker image of the application
  2. Deploys it to Dokploy with a unique preview URL
  3. Comments on the PR with the preview URL

Preview Cleanup (preview-down.yml)

When a PR is closed (merged or abandoned), the workflow automatically:

  1. Removes the preview deployment from Dokploy
  2. Cleans up associated resources

Required Secrets

The following secrets need to be configured in your repository settings:

Docker Hub Authentication:

  • DOCKER_USERNAME: Your Docker registry username
  • DOCKER_PASSWORD: A Docker registry password

if using a different registry than docker hub, change registry input for action ./.github/actions/build-docker in preview-up.yml

AWS Cache (Optional):

  • AWS_ACCESS_KEY_ID: AWS access key for S3 cache
  • AWS_SECRET_ACCESS_KEY: AWS secret key for S3 cache

Dokploy Deployment:

  • DOKPLOY_BASE_URL: The base URL of your Dokploy instance
  • DOKPLOY_TOKEN: Authentication token for Dokploy API access

The workflows use these secrets to:

  • Push built images to Docker Hub
  • Store build cache in AWS S3 (if configured)
  • Deploy and manage preview environments in Dokploy