Skip to main content

Prerequisites

Before you begin setting up the Supabase TDD Boilerplate, ensure you have the following tools and accounts set up:

Getting Started​

First, clone the repository:

git clone https://github.com/Just-Understanding-Data-Ltd/supabase-tdd-boilerplate.git
cd supabase-tdd-boilerplate

Required Tools​

  1. Git: For version control. Install Git

  2. PNPM: Required for managing the monorepo. Install using npm:

    npm install -g pnpm

  3. Docker: Required for running Supabase locally. Install Docker

  4. Supabase CLI: Already included in the monorepo's dependencies. You can verify it's working by running:

    cd packages/supabase
    npx supabase --version

Required Accounts (All services offer free tiers to get started)​

  1. GitHub Account: For version control and deployment. Sign up for GitHub.

  2. Supabase Account: For database and authentication. Sign up for Supabase.

  3. Google Cloud Account: For Google Sign-In. Sign up for Google Cloud.

Development Environment​

  • A code editor (we recommend VS Code or Cursor)
  • Git for version control
  • Terminal with shell support (bash, zsh, etc.)
  1. TypeScript and JavaScript Language Features: Built into VS Code
  2. ESLint: For code linting
  3. Prettier: For code formatting
  4. Vitest: For test running and debugging
  5. Docker: For Docker container management
  6. Turborepo: For monorepo management
  7. Next.js: For Next.js development
  8. Tailwind CSS: For styling

Project Structure​

The project follows a monorepo structure:

supabase-tdd-boilerplate/
├── apps/
│   ├── web/          # Next.js frontend application
│   └── api/          # Hono API application
├── packages/
│   ├── supabase/     # Supabase configuration and migrations
│   ├── ui/           # Shared UI components
│   └── config/       # Shared configuration
├── tools/            # Development tools and scripts
└── docs/             # Documentation

Next Steps​

Once you have all the prerequisites in place, you're ready to:

  1. Set up Supabase locally
  2. Configure the database
  3. Set up Google Sign-In