Skip to content
WP Engine Developer Docs Example

Getting Started with Atlas

Getting Started with Atlas

Section titled “Getting Started with Atlas”

This guide will help you build your first headless WordPress application with Atlas.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have:

  • Node.js 18.x or higher
  • A WP Engine account with Atlas enabled
  • Basic knowledge of JavaScript and React
  • Git installed on your system

Creating Your First Project

Section titled “Creating Your First Project”

Step 1: Initialize a New Atlas App

Section titled “Step 1: Initialize a New Atlas App”
Terminal window
npx create-atlas-app my-first-atlas-app
cd my-first-atlas-app

Step 2: Connect to WordPress

Section titled “Step 2: Connect to WordPress”
Terminal window
atlas connect --url=https://your-site.wpengine.com

Step 3: Start the Development Server

Section titled “Step 3: Start the Development Server”
Terminal window
npm run dev

Your Atlas application will be available at http://localhost:3000.

Project Structure

Section titled “Project Structure”
my-first-atlas-app/
├── src/
│   ├── pages/
│   ├── components/
│   └── lib/
├── public/
├── atlas.config.js
└── package.json

Next Steps

Section titled “Next Steps”

Common Issues

Section titled “Common Issues”

Connection Failed

Section titled “Connection Failed”

If you’re unable to connect to WordPress, verify:

  • Your WordPress URL is correct
  • Atlas plugin is installed and activated
  • Your API credentials are valid

Build Errors

Section titled “Build Errors”

Check that all dependencies are installed:

Terminal window
npm install

Getting Help

Section titled “Getting Help”

Need assistance? Check out these resources: