Docs/Installation

Installation

Get started with WP2Astro - no local setup required. Everything runs in GitHub Codespaces.

Getting started with WP2Astro is incredibly simple. Unlike traditional development tools, you don't need to install anything locally - no Node.js, no npm, no build tools. Everything runs in the cloud through GitHub Codespaces.

What You'll Need

The only requirement to use WP2Astro is:

  • A GitHub account (free or paid)

That's it! WP2Astro handles all the technical setup for you.

Why No Local Setup?

WP2Astro uses GitHub Codespaces to provide a complete development environment in your browser:

  • ✅ No installation required - Start coding immediately
  • ✅ Consistent environment - Works the same for everyone
  • ✅ Powerful cloud servers - Fast builds and previews
  • ✅ Access from anywhere - Work from any device with a browser
  • ✅ Pre-configured - Astro, dependencies, and dev server ready to go

[screenshot of the dashboard]

Step 1: Create Your Account

Visit wp2astro.com and sign up:

  1. Click "Get Started" or "Sign Up"
  2. Enter your email and create a password
  3. Verify your email address
  4. You're ready to go!

Step 2: Connect Your GitHub Account

WP2Astro needs access to your GitHub account to:

  • Create repositories for your Astro sites
  • Set up GitHub Codespaces for browser-based editing
  • Enable automatic deployments

To Connect GitHub:

  1. Navigate to your WP2Astro dashboard
  2. Click "Connect GitHub Account"
  3. Authorize WP2Astro to access your GitHub
  4. Choose repository visibility (public or private)

What WP2Astro Can Do:

  • Create and manage repositories for your sites
  • Create GitHub Codespaces for development
  • Push code changes to your repositories
  • Set up deployment webhooks

Important: Your GitHub credentials are never stored. We only use OAuth tokens with specific permissions.

Understanding Your Workflow

Here's how WP2Astro works:

1. Create Project in WP2Astro Dashboard ↓ 2. GitHub Repository Created Automatically ↓ 3. Codespace Provisioned (cloud development environment) ↓ 4. Access IDE in Your Browser ↓ 5. Edit, Preview, and Deploy

GitHub Codespaces Limits

GitHub provides free Codespace hours based on your account type:

  • Free Account: 120 core-hours/month + 15 GB storage
  • Pro Account: 180 core-hours/month + 20 GB storage
  • Team/Enterprise: Organization-managed limits

What does this mean?

  • A 2-core machine gives you 60 hours of active use per month (free tier)
  • Codespaces automatically shut down after 4 hours of inactivity
  • You can delete unused codespaces to free up resources

[screenshot of codespace status]

Do I Need a WordPress Site?

No! WordPress import is completely optional. You can:

  • Start from scratch - Create a blank Astro site with our templates
  • Import from WordPress - Migrate existing WordPress content
  • Mix and match - Start blank and import content later

WP2Astro is not just a migration tool - it's a complete platform for building Astro sites.

What Gets Set Up For You

When you create a project, WP2Astro automatically:

  1. Creates a GitHub repository with:

    • Complete Astro project structure
    • Pre-configured build settings
    • Development dependencies
    • Git version control

  2. Provisions a Codespace with:

    • Node.js and npm pre-installed
    • Astro development server ready
    • Live preview capability
    • Terminal access for advanced users

  3. Configures the IDE with:

    • Monaco code editor (VS Code engine)
    • File tree navigation
    • Auto-save functionality
    • Syntax highlighting

No Local Development Needed

Everything happens in the cloud:

  • Editing: Browser-based IDE with full Astro support
  • Building: Automated builds in the cloud
  • Preview: Live preview in the IDE
  • Deployment: One-click deploy to Vercel

However, if you prefer local development, you can always clone your repository:

# Clone your repository
git clone https://github.com/yourusername/your-site.git
cd your-site

# Install dependencies
npm install

# Start dev server
npm run dev

But remember - this is optional. Most users never need to work locally.

System Requirements

Since everything runs in the cloud, the only requirement is:

  • Modern web browser (Chrome, Firefox, Safari, Edge)
  • Stable internet connection

No specific operating system, memory, or processor requirements!

Free Tier Limitations

WP2Astro works within GitHub's free tier limits:

  • Create unlimited repositories (public or private)
  • Use GitHub Codespaces within your monthly quota
  • Deploy unlimited sites to Vercel (free tier)

Both GitHub and Vercel offer generous free tiers perfect for personal projects and small sites.

Troubleshooting

GitHub Connection Failed

If GitHub authorization fails:

  1. Try disconnecting and reconnecting
  2. Check that you approved all permissions
  3. Make sure pop-ups aren't blocked
  4. Try a different browser

Can't Create Codespace

If codespace creation fails:

  1. Check your GitHub account has codespace access
  2. Verify you haven't exceeded your monthly quota
  3. Try creating a public repository instead of private
  4. Delete unused codespaces to free up resources

Browser Compatibility

For the best experience, use:

  • Chrome 90+
  • Firefox 88+
  • Safari 14+
  • Edge 90+

Older browsers may have issues with the IDE.

Next Steps

Now that you understand the setup, let's create your first project:

→ Continue to Quick Start

Need Help?

If you encounter any issues during setup:

Previous
Introduction
Next
Quick Start