> ## Documentation Index
> Fetch the complete documentation index at: https://www.propeldata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get up and running with Propel in under 5 minutes.

<div />

In this quickstart, you'll learn how to:

<Icon icon="check" iconType="solid" /> Create a Propel account<br />
<Icon icon="check" iconType="solid" /> Create a Data Pool with sample data<br />
<Icon icon="check" iconType="solid" /> Query the data<br />
<Icon icon="check" iconType="solid" /> Create a Propel Application and get the API credentials<br />
<Icon icon="check" iconType="solid" /> Run the Propel Next.js Starter App

## Prerequisites

* Node.js 18.17 or later.

Let's get started 🚀

<Steps>
  <Step title="Create a Propel Account">
    Go to the [sign-up page](https://console.propeldata.com/get-started), enter your email, password, and click **"Get Started"**.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/01-signup_1.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=09d68d5dc12565a56e408566ca5e0b1c" alt="Propel Account set up step 1" width="1919" height="968" data-path="images/docs/quickstart/01-signup_1.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/01-signup_2.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=1862d55e3524a8a27bc138ac3d2b3fae" alt="Propel Account set up step 2" width="1919" height="967" data-path="images/docs/quickstart/01-signup_2.png" />
    </Frame>

    Confirm your email and log in again.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/01-signup_3.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=25c7a1064da6674827e04540dd6f871c" alt="Propel Account set up step 3" width="1919" height="969" data-path="images/docs/quickstart/01-signup_3.png" />
    </Frame>

    Once you log in, your account will be created, and you will land in the Propel Console.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/01-signup_4.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=6488c5fb6f7ce7d8aea8dd99309708f4" alt="Propel Account set up step 4" width="1907" height="960" data-path="images/docs/quickstart/01-signup_4.png" />
    </Frame>
  </Step>

  <Step title="Create a Data Pool with sample data">
    Next, we need some sample data to work with.

    We'll need to create a Data Pool. Data Pools are ClickHouse tables that ingest from a data source.

    Go to **"Data Pools"**, then click **“Create Data Pool”**.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/02-data_pool_01.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=ce487d2bd30779a98526e94d256308d6" alt="Propel Data Pool set up step 1" width="1913" height="956" data-path="images/docs/quickstart/02-data_pool_01.png" />
    </Frame>

    At Propel, we love tacos. So our sample data is taco-themed  🌮!

    You will see all data sources supported, as well as the “TacoSoft Demo Data”.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/02-data_pool_01b.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=3a952faa7969cd2003a69273a83bf48d" alt="Propel Data Pool set up step 1b" width="1411" height="937" data-path="images/docs/quickstart/02-data_pool_01b.png" />
    </Frame>

    Select the “TacoSoft Demo Data”, then click **"Create Data Pool"**.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/02-data_pool_02.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=4f90bff73521012b4558f0ccdef00ed4" alt="Propel Data Pool set up step 2" width="1676" height="424" data-path="images/docs/quickstart/02-data_pool_02.png" />
    </Frame>

    Once you create it, you will see the “TacoSoft Demo Data” Data Pool.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/02-data_pool_03.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=5b0f442733269b44afc7439c7d5ff02d" alt="Propel Data Pool set up step 3" width="1681" height="535" data-path="images/docs/quickstart/02-data_pool_03.png" />
    </Frame>

    You can click on it and the Data Pool will start syncing.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/02-data_pool_04.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=21564bbb87c31024d107d2e481602980" alt="Propel Data Pool set up step 4" width="1905" height="956" data-path="images/docs/quickstart/02-data_pool_04.png" />
    </Frame>

    Once it's finished, on the **"Preview Data"** tab, you can see the actual data.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/9FdNDTkhOu7EgAUd/images/docs/quickstart/02-data_pool_04b.png?fit=max&auto=format&n=9FdNDTkhOu7EgAUd&q=85&s=04f41cef796adfa39a449324151c86fd" alt="Propel Data Pool set up step 4b" width="1910" height="959" data-path="images/docs/quickstart/02-data_pool_04b.png" />
    </Frame>
  </Step>

  <Step title="Query the data using SQL">
    Now that you have a Data Pool with data, let's query it!

    Go to the **"SQL Console"** in the left-hand sidebar.

    ```sql theme={"system"}
    SELECT
      *
    FROM
    "TacoSoft Demo Data";
    ```

    And see the results!

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/docs/quickstart/03-sql_01.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=3b07c10f7dbaec8953c2f132d763fad5" alt="Propel SQL Console" width="1439" height="941" data-path="images/docs/quickstart/03-sql_01.png" />
    </Frame>
  </Step>

  <Step title="Query the data via the API">
    Now that you've queried the data via SQL, let's query the data via the API.

    Under the **"API"** section, click on the **"Playground"** in the left-hand sidebar.

    The API Playground is a powerful tool for exploring your data and constructing queries. It provides an interactive interface on the left side for building queries, and displays the corresponding GraphQL API request on the right side.

    To create your first query, follow these steps:

    1. API type: Choose the **"Time Series"** API from the dropdown menu.
    2. Data source: Select the **"TacoSoft Demo Data"** Data Pool.
    3. Metric: Pick the **"COUNT"** Metric to count the number of records.
    4. Execute: Click the **"Run Query"** button to execute your query.

    As you make selections, observe how the GraphQL query on the right side updates in real-time. This helps you understand how to structure API requests for your application.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/docs/quickstart/05-query_01.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=a9bdd87485993d46edef4374f98d02d3" alt="Propel query data" width="1426" height="1002" data-path="images/docs/quickstart/05-query_01.png" />
    </Frame>

    This query will return the total number of order items over time.

    🎉🍾🎈 You've made your first query!
  </Step>

  <Step title="Create a Propel Application and get the API credentials">
    Next, we'll want to make queries from a Next.js application.

    To get your API credentials, you'll need to create a Propel Application.

    Go to the **"Applications"** section and click **"Create Application"**. Enter the following information:

    * Give your Application a unique name: “TacoSoft App”
    * Give your Application a description: “TacoSoft App”
    * For the [API scopes](/docs/applications#scopes), you'll want your Propel Application to have the “DATA\_POOL\_QUERY” scope.
    * The Propeller determines how fast the queries made with this Application are. For our Quickstart, you can select `P1_X1_SMALL`.
    * Click **"Create"**

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/docs/quickstart/05-application_01.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=d55625cf52ead7b602bdedf87fa81aa1" alt="Create a Propel Application" width="1434" height="946" data-path="images/docs/quickstart/05-application_01.png" />
    </Frame>
  </Step>

  <Step title="Run the Propel Next.js Starter App">
    The Propel Next.js Starter App is a project bootstrapped with create-next-app, integrated with Propel's Embeddable UI Kit to create a sample dashboard.

    First, clone [the repo](https://github.com/propeldata/propel-nextjs-starter-app-v2) for the Propel Next.js Starter App:

    ```bash theme={"system"}
    git clone https://github.com/propeldata/propel-nextjs-starter-app-v2.git
    ```

    or

    ```bash theme={"system"}
    gh repo clone propeldata/propel-nextjs-starter-app-v2
    ```

    Once you've cloned the repo, `cd` into its directory:

    ```bash theme={"system"}
    cd propel-nextjs-starter-app-v2
    ```

    You'll need to set your Propel Application's client ID and secret in a `.env.local` file. To do this, first make a copy of the `.env.sample` included in the app's root directory:

    ```bash theme={"system"}
    cp .env.local.sample .env.local
    ```

    Then, update the `.env.local` file to include your Propel Application's client ID and secret:

    ```bash theme={"system"}
    CLIENT_ID=1jb…
    CLIENT_SECRET=1og…
    ```

    Install dependencies:

    ```bash theme={"system"}
    npm install
    ```

    Now you are good to run the app locally!

    ```bash theme={"system"}
    npm run dev
    ```

    Now, if you visit [http://localhost:3000](http://localhost:3000), you'll see your app running.

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/docs/quickstart/06-starter_app.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=59c1c97cb5899847b0111e59fbb9c7df" alt="Propel Starter App" width="1185" height="1127" data-path="images/docs/quickstart/06-starter_app.png" />
    </Frame>

    Now you have a working Next.js app serving data from Propel 🎉!
  </Step>
</Steps>
