• Stars
    star
    126
  • Rank 284,543 (Top 6 %)
  • Language
    TypeScript
  • License
    Mozilla Public Li...
  • Created over 1 year ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The missing GraphQL IDE

Pathfinder

Pathfinder

The missing GraphQL IDE

Free, open-source and cross-platform

The Pathfinder desktop application

Installation & Usage

pnpm add @pathfinder-ide/react # or yarn add @pathfinder-ide/react or npm install @pathfinder-ide/react

The sole export from @pathfinder-ide/react is a React component called Pathfinder. For our initial release, a limited set of props is allowed. You can see examples of props usage in the pathfinder.stories.tsx file.

Local development

Clone the repository

git clone https://github.com/grafbase/pathfinder.git

Install packages

cd pathfinder
pnpm i

Update .env

The primary development environment for Pathfinder is ladle and the Pathfinder stories are set up to use environment variables. Make a copy of the example file:

cd apps/ladle
cp .env.development.local.example .env.development.local

Once copied, you can open .env.development.local and add an endpoint, at a minimum, and auth header key/value if necessary.

Build monaco workers

Building the necessary workers ahead of time absolves consuming code from having to fuss with build tool plugins. This is good.

pnpm react:build:workers

Run ladle

pnpm ladle:serve

Ladle is at http://localhost:61000/.