Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grafbase/pathfinder
The missing GraphQL IDE
https://github.com/grafbase/pathfinder
app component graphql ide react tauri
Last synced: 3 months ago
JSON representation
The missing GraphQL IDE
- Host: GitHub
- URL: https://github.com/grafbase/pathfinder
- Owner: grafbase
- License: mpl-2.0
- Created: 2023-08-08T07:58:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-07T15:49:36.000Z (3 months ago)
- Last Synced: 2024-08-07T19:00:40.367Z (3 months ago)
- Topics: app, component, graphql, ide, react, tauri
- Language: TypeScript
- Homepage: https://pathfinder.dev
- Size: 13.3 MB
- Stars: 126
- Watchers: 7
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Pathfinder
The missing GraphQL IDE
Free, open-source and cross-platform
# Installation & Usage
```bash
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
```bash
git clone https://github.com/grafbase/pathfinder.git
```
## Install packages
```bash
cd pathfinder
pnpm i
```
## Update .env
The primary development environment for Pathfinder is [ladle](https://ladle.dev/) and the Pathfinder stories are set up to use environment variables. Make a copy of the example file:
```bash
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.
```bash
pnpm react:build:workers
```
## Run ladle
```bash
pnpm ladle:serve
```
Ladle is at `http://localhost:61000/`.