Skip to content

Commit

Permalink
update readme & rm empty file
Browse files Browse the repository at this point in the history
  • Loading branch information
o-az committed Aug 2, 2023
1 parent 42e3719 commit b6181fb
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
uses: lagonapp/github-action@latest
with:
lagon_token: ${{ secrets.LAGON_TOKEN }}
command: deploy --prod
command: deploy --production
site_url: "${{ env.BASE_URL }}"

config: |
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# GraphQL Introspection & Schema Retrieval (JSON & SDL)
# Introspect

## API to fetch entire schema of any (public) GraphQL API and return it as JSON or SDL
### ⚡ Serverless Function deployed to serve you entire schema as JSON or SDL of any (public) GraphQL API

#### Try it
#### Deployed on [Lagon](https://lagon.app/) - [Open Source JS Runtime](https://github.com/lagonapp/lagon)

### Try it

This will fetch the full JSON schema of Uniswap's GraphQL API and return it as JSON

[`https://introspect.lagon.dev/json/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3`](https://introspect.lagon.dev/json/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3)

### 🔗 <https://introspect.lagon.dev>
#### 🔗 <https://introspect.lagon.dev>

## Usage

Expand Down
Binary file modified bun.lockb
Binary file not shown.
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
"name": "introspect",
"version": "0.0.1",
"description": "API to fetch entire schema of any (public) GraphQL API and return it as JSON or SDL.",
"main": "./src/index.ts",
"module": "./src/index.ts",
"types": "./src/index.ts",
"source": "./src/index.ts",
"type": "module",
"scripts": {
"dev": "lagon dev --env='.env.dev'"
"dev": "lagon dev --env='.env.dev'",
"deploy:preview": "lagon deploy",
"deploy": "lagon deploy --production"
},
"keywords": [],
"author": "https://github.com/o-az",
Expand All @@ -16,8 +18,10 @@
"graphql": "^16.7.1"
},
"devDependencies": {
"@lagon/cli": "^0.7.8",
"@types/node": "^20.4.5",
"bun-types": "^0.7.1",
"esbuild": "^0.18.17",
"typescript": "^5.1.6"
}
}
Empty file removed scripts/bun.ts
Empty file.
2 changes: 1 addition & 1 deletion src/utilities.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export const BASE_URL = process.env.BASE_URL || 'https://introspect.lagon.dev'
export const BASE_URL = process.env.BASE_URL ?? 'https://introspect.lagon.dev'

export const EXAMPLE_GRAPHQL_URL = 'https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3'

Expand Down

0 comments on commit b6181fb

Please sign in to comment.