Create a project

This is for:

Developer

You can generate a basic Atomic search page in the Coveo Administration Console or with the Coveo CLI.

Use the Administration Console

The Simple Builder & Classic Interface Editor tab on the Search Pages (platform-ca | platform-eu | platform-au) page of the Administration Console offers two WYSIWYG tools that let you create and edit search pages.

Select the Simple builder to create and customize a basic Atomic search page. If you want more flexibility, you can download your page so that you can customize it locally.

Important

Pages created with the Classic Interface Editor are built upon the Coveo JavaScript Search Framework.

Use the Coveo CLI

Before you can use the Coveo CLI to create a basic Atomic search page, you’ll need to have a Coveo organization with an active source.

  1. Install the Coveo CLI.

  2. Navigate to the folder in which you want to create your search page.

  3. Run coveo auth:login to connect to your organization.

    Tip

    By default, this command connects to whichever organization you’re currently logged in with. If you belong to multiple organizations, you can append the -o=<ORG_ID> flag to connect to a specific one.

  4. Run coveo ui:create:atomic <YOUR_PROJECT_NAME>.

    You may be asked to install Coveo Atomic. If so, select Y, and then select Enter.

  5. In the next interactive prompt, select Start from scratch.

    The Coveo CLI will create a Stencil project for you. Stencil is the same toolchain that was used to create the Coveo Atomic project itself.

    Tip

    If you have any existing search pages on the Search Pages (platform-ca | platform-eu | platform-au) page of the Administration Console, they will be listed under Start from scratch.

  6. Navigate to the folder for your new Atomic project.

  7. Run npm start.

    Once the build finishes, your browser should open to your new Atomic search page.

What’s next?