-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* wip * chore: upgrade next and react * schema: update github schema * schema: auto generate ghall schema * schema: update ghall schema * schema: fix missing types * chore: regen schema * chore: upgrade apollo and graphql * chore: regen schema * wip * chore: rename to ghall * chore: update README * chore: upgrade typescript * chore: update next * wip * wip * wip
- Loading branch information
Showing
37 changed files
with
12,407 additions
and
9,917 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,23 @@ | ||
Access GitHub public data through REST or GraphQL api **without authorization** | ||
|
||
## REST Api | ||
|
||
## GraphQL Api | ||
|
||
the design principle of `ghack` GraphQL api is: | ||
|
||
`ghack` GraphQL api should be a subset of [GitHub GraphQL Api](https://docs.github.com/graphql), which means: | ||
|
||
- [`ghack` graphql schema](schema.ghack.graphql) should be a subset of [GitHub public graphql schema](https://docs.github.com/public/schema.docs.graphql), | ||
`WIP` Still working in progress | ||
|
||
- each query to `ghack` graphql api, should be also a valid query for GitHub GraphQL Api, and have same response | ||
|
||
For short: **`ghack` GraphQL api is an implementation for a subset of GitHub GraphQL Api** | ||
|
||
## Getting Started | ||
|
||
First, run the development server: | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
``` | ||
## REST Api | ||
|
||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
> Documentation for REST Api is not completed yet | ||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. | ||
## GraphQL Api | ||
|
||
## Learn More | ||
- `Api Endpoint` https://ghall.now.sh/api | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
- `Api Explorer` https://ghall.now.sh/graphiql | ||
|
||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
the design principle of `ghall` GraphQL api is: | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
`ghall` GraphQL api should be a subset of [GitHub GraphQL Api](https://docs.github.com/graphql), which means: | ||
|
||
## Deploy on Vercel | ||
- [`ghall` graphql schema](schema.ghall.graphql) should be a subset of [GitHub public graphql schema](https://docs.github.com/public/schema.docs.graphql), | ||
|
||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
- each query to `ghall` graphql api, should be also a valid query for GitHub GraphQL Api, and have same response | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
In short: **`ghall` GraphQL api is an implementation for a subset of GitHub GraphQL Api** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
812291a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: