Documentation

Set up your project

Elevate, May 20-22-2025, Miami Beach, Florida

Set up your project to develop your website locally.

Prerequisites
  • Node.js installed locally (version 22.x; other versions greater than or equal to 16.14 are also supported but not recommended)
  • Yarn installed locally (version 2.x+)
  • CLI installed
  • Access to your GitHub customer repository
  • Access to your Studio (https://<customer>.frontastic.io)

To get started with development, follow these steps:

  1. Get your API token from the Studio.
  2. Set up your project locally.

Get your API token from the Studio

To get your API token from the Studio, follow these steps:

  1. From the Studio homepage, click the Account icon, then select Profile: the User settings dialog opens.
  2. Copy the value in the API token field and close the dialog.
  3. Save the copied value for later use.

Set up your project locally

To set up your project locally, follow these steps:

  1. Clone the GitHub repository of your commercetools Frontend project on your computer.
  2. Open a command-line tool and move to the root directory of your repository.
  3. To initialize your project, run frontastic init in your command-line tool: you'll be prompted to enter the Studio user API token.
  4. Enter the API token you copied from the Studio.
  5. To install the necessary dependencies, run frontastic install in your command-line tool.
  6. To start your commercetools Frontend project, run frontastic run in your command-line tool. Once it has finished, you can preview your website by opening http://localhost:3000 in a web browser.

You can now start developing your website in your favorite IDE.