Skip to main content

Project setup

Uniform Context is configured on a per-project basis. Since you are adding Uniform Context functionality to a web application, you must create & configure a Uniform project to store the configuration & settings for the web app.

Create project​

This section guides you through the process of creating a new Uniform project using the Uniform dashboard.

  1. Log into the Uniform dashboard at https://uniform.app

  2. Create an empty project with the following name: Context Tutorial

  3. The project page is displayed.

Add API key​

The web application will need to read data & settings from the Uniform project. This requires a valid API key be assigned to the project, and for the right permissions assigned to the key.

  1. In the Uniform dashboard, navigate to Settings > API Keys

  2. Add the following API key:

    • Name: Context Tutorial key
    • Select the Context Tutorial project we created before.

  3. Under the Uniform Context section, make sure to toggle only the minimim required permission.

    Minimum read-only permissions

    The minimum required permissions to be able to read all the Context configuration: Read Drafts and Manifest Read.

    caution

    If you need to be able to push Context definitions via Uniform CLI or perform full CRUD operations over Uniform API, you may need more permissions to be able to perform those operations:

  4. Click Set Permissions to accept the permission selection.

  5. Click Create API Key to complete the operation.

  6. Two values are displayed: the API key and the Project id.

    Copy both of these values. You will need them later.

    caution

    This is the only time the API key will be displayed. If you lose the value you will need to create a new one.