Create Your Site | Yext Hitchhikers Platform

What You’ll Learn

In this section, you will:

  • Build and preview your site locally
  • Learn about Entity vs. Static Page Types


Let’s start building! We’ll walk through how to create a site locally.

Video Walkthrough

In the video, Andrew walks through the steps below.

1. Connect to your Yext Account

  1. Log in to your Yext account and copy your account ID which is visible in the URL (refer to the screenshot below):


  2. Determine if you are using a sandbox or production environment.

    • In the screenshot above, the URL begins with; meaning you are using a sandbox account.
    • If you are using a production account, the url will be simple .
  3. Connect to your account using the CLI.

    • If you are connecting to a sandbox (aka Playground) account, run:

      yext init -u sandbox <account_id>
    • If you are connecting from a production account, run:

      yext init <account_id>
  4. A new tab will open in your browser asking you to authorize access. Click Authorize. If you are not logged in to your Yext account, you will be prompted to log in.

2. Build Your First Site

  1. Once logged in, navigate to suitable directory to contain your Pages project and run:

    yext pages new
  2. You will then be walked through a series of prompts. To follow along with this project, respond to the prompts with the following:

    1. Would you like to create a new repo or link and existing GitHub repo? Create a new repo
    2. Which starter repository would you like to use? Locations Starter (Basic)
    3. What would you like to call your new Pages repo? turtlehead-tacos-demo-restaurant-site
    4. Would you like to setup a remote GitHub repository for turtlehead-tacos-demo-restaurant-site? Y or enter
      • This will set up a remote repo and make deploying your site really easy.
      • If you are not logged into GitHub, the command will prompt you to log in. Follow the instructions through the browser and return to the command line when finished. If you are already logged in, just continue with enter.
    5. Would you like to install dependencies for turtlehead-tacos-demo-restaurant-site? Y or enter
      • This runs npm i under the hood and install all the required dependencies.
    6. Would you like to populate your Content with seed data? (Recommended if you are starting with a fresh account) Y
      • Be careful when adding seed data to an account with existing data as it may update or delete existing data.
    7. Warning: Are you sure you want to overwrite configuration resources for the current configuration? Yes
      • Confirm you are connected to the correct account.
  3. Once you have started your site, follow the directions from the terminal and run the following:

    cd turtlehead-tacos-demo-restaurant-site
    npm run dev
  4. Your site will now be running locally at localhost:5173. You should see the Pages Development page as in this screenshot:

    Pages Development Page

Types of Pages

From the Pages Development Screen, you can see there are two types of supported pages: static and entity pages.

  • Entity pages are powered by Streams, which is the Yext system responsible for delivering data from the Content to your frontend code. An entity template is used to create a page for each eligible entity delivered via stream.

  • Static pages, on the other hand, are individual, one-off pages (e.g. index, about, etc.).

We’ll dive into more detail in the Overview of Templates unit .

Entity Pages

Let’s explore the Entity Pages. From the Pages Development Page at localhost:5173, you can see multiple entity pages, which are generated from streams. Click through some of the entity pages and you’ll notice they have the same structure but different data (click “Home” in the nav bar to return to the Pages Development Page).

Take a look at the path for the entity pages. For example:

  • localhost:5173/location1-meatpacking is the page generated based on data from entity ID location1.
  • You’ll notice the location-specific data displayed on the page comes directly from the “location1” JSON document in your localData/ folder. This folder is a local JSON representation of the data that lives in your Content!
  • If you search for the slug field in this document, you’ll notice this field is what currently defines the page path: location1-meatpacking.

localData location1 JSON document

Static Pages

View the static page at localhost:5173/index.html or you can navigate directly to the page from the Pages Development Page. You can edit this file at ./src/templates/static.tsx.

Static pages are simple and are generally used when you want to develop a page that isn’t directly based on data stored in the platform (e.g. index, about-us, privacy policy, etc.).

Although static pages are not powered directly by Streams, they can still be updated through Global Data , which you’ll learn more about in Module 2.

unit Quiz
+20 points
Daily Quiz Streak Daily Quiz Streak: 0
Quiz Accuracy Streak Quiz Accuracy Streak: 0
    Error Success Question 1 of 2

    You’re hosting various events at Turtlehead Tacos locations and want each event to have a page that uses the same structure. Which type of Pages template should you use?

    Error Success Question 2 of 2

    Where can you get entity content to view your site locally?

    Soon you'll be your brand's hero! 🎓

    You've already completed this quiz, so you can't earn more points.You completed this quiz in 1 attempt and earned 0 points! Feel free to review your answers and move on when you're ready.
1st attempt
0 incorrect