Installing a Starter Application
Get up and running in a few steps and start developing Custom Applications for the Merchant Center.
Before you start development, you should have the following:
- Install one of the starter templates using the
npx @commercetools-frontend/create-mc-app \my-new-custom-application-project \--template starter
- Configure the application environment:
custom-application-config.json is configured to use the HTTP APIs in the GCP-EU region. If you plan to run the Custom Application in another environment, change the cloud identifier accordingly.
- Start the development server:
cd my-new-custom-application-projectnpm start
If you use
cd my-new-custom-application-projectyarn start
The browser opens a new tab pointing to
http://localhost:3001, with a login screen (for development only). Log in using your commercetools account as usual.
Note that Single Sign On is not supported at the moment for the development login page. If you are interested in this functionality, let us know and open a support issue.
Once you've authenticated, you are redirected to the application
:projectKey is your commercetools project.
The starter application defines
example-starter as the main application route path (see
src/components/entry-point). This is the route that identifies your application and is used by the proxy router. Check out the Merchant Center architecture to know more about this.
Be sure to choose a value that does not conflict with one of the official route values, otherwise your Custom Application will never be served.
The official main route path values are (the list can be extended at any time):
You should choose a value that fits with the purpose of the application you are developing. For example, if your application manages state machines, you can choose to name the route