Skip to content
Astro Church Docs

Installation

Get your Astro project started with Astro Church.

Prerequisites

Section titled “Prerequisites”
  • Node.js: v18.20.8 or v20.3.0, v22.0.0 or higher. (v19 and v21 are not supported.)
  • Package Manager: npm, yarn, or pnpm

Option 1: Create New Project

Section titled “Option 1: Create New Project”

Best for starting fresh with a clean git history.

Terminal window
npm create astro@latest -- --template tmykkanen/astro-church

Option 2: Fork Repository

Section titled “Option 2: Fork Repository”

Best for contributing to the theme, theme development, or if you want to track upstream changes via git.

  1. Fork on the Web: Click the “Fork” button on the repository’s page in your browser.

  2. Clone your fork:

    Terminal window
    git clone https://github.com/YOUR-USERNAME/repository-name.git

  3. Add the Original as “Upstream”: To keep your fork updated with the original project, you need to link it manually:

    Terminal window
    git remote add upstream https://github.com/tmykkanen/astro-church.git

Initial Setup

Section titled “Initial Setup”

  1. Copy the environment example file:

    Terminal window
    cp .env.example .env

  2. Edit .env with your information. See Setting Up the Events Page and Setting Up the Subscribe Form for more info:

    RESEND_API_KEY=""
    RESEND_SEGMENT_ID=""
    PUBLIC_GOOGLE_CALENDAR_API_KEY=""
    PUBLIC_GOOGLE_CALENDAR_ID=""

  3. Start the development server:

    Terminal window
    npm run dev

Next Steps

Section titled “Next Steps”
Configure your site
Explore custom version of PagesCMS