Skip to main content

Quickstart

The quickest way to get started is using the project generator in @palantir/pack.create-app.

1. Create a Developer Console Application​

To connect your application to Foundry, you'll need to create a Developer Console Application. Full documentation for this can be found here.

  • Ensure you create a Client-facing Application.
  • Add a redirect URL for http://localhost:5173/auth/callback
    • This is the default address used by @palantir/pack.create-app
  • Note the Client ID on the Overview page of your dev-console app, we'll need this in the next step.

After creating the application, you'll need to enable the PACK APIs in the Platform SDK.

2. Scaffold a workspace​

Create a new PACK workspace starter (a schema + sdk + app npm workspace) using the wizard from the create-app CLI.

You'll need:

  • the URL of your Foundry stack, e.g. https://my-customer-name.palantircloud.com/,
  • the Client ID copied from the previous step,
  • the Ontology RID of the Ontology you'll use along side this application
    • this can be found in the Ontology configuration section of Ontology Manager
  • the Compass folder RID where new documents will be created
    • this is the RID of the Compass folder that will hold documents created by your app, and can be found on the folder's Overview panel
npx @palantir/pack.create-app -t workspace

This will create a new folder with the name of your project, cd into this folder:

cd my-pack-app

3. Generate the SDK​

npm run sdk-gen    # generate the SDK from packages/schema
npm run build:sdk  # compile the generated SDK

Re-run sdk-gen then build:sdk whenever you change packages/schema/src/schema.mjs.

4. Deploy the document type​

Before the app can read or write documents, deploy the document type defined in packages/schema to your Foundry stack. Deployment authenticates with a Foundry token rather than the browser OAuth flow, so you must provide one:

  • Generate a token under User Settings → Tokens in Foundry.
  • Export it as FOUNDRY_TOKEN in your shell.

The stack URL and the Compass parent folder you supplied when scaffolding are already baked into the deploy script, so FOUNDRY_TOKEN is the only value you need to set:

export FOUNDRY_TOKEN=<your-token>
npm run deploy

Re-run npm run deploy whenever you change the schema and want to update the deployed document type.

5. Run the app​

npm run dev        # start the example app

On first load the app kicks off the OAuth flow, redirecting you to Foundry to sign in and then back to /auth/callback.

Package Setup​

A typical PACK app contains three packages:

  1. A schema package.
    1. This uses the schema builder functions from "@palantir/pack.schema" to define a versioned schema for an application.
    2. Contains scripts for generating the SDK from this schema, using "@palantir/pack.sdkgen" and the versioned SDK template "@palantir/pack.sdkgen.pack-versioned-template".
  2. An SDK package.
    1. This is generated from the above schema definition, and provides a versioned set of types and utilities for interacting with your defined documents, activity and presence events.
  3. An Application package.
    1. This is your application, which takes a dependency on the SDK and on the core PACK libraries. This is often an OSDK application, reading and writing data from the Foundry Ontology in addition to using PACK for application state.