https://github.com/codex-team/hawk.api.nodejs
GraphQL API for Hawk Garage
https://github.com/codex-team/hawk.api.nodejs
apollo-server graphql-server nodejs
Last synced: about 2 months ago
JSON representation
GraphQL API for Hawk Garage
- Host: GitHub
- URL: https://github.com/codex-team/hawk.api.nodejs
- Owner: codex-team
- Created: 2019-04-25T05:13:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T11:11:11.000Z (2 months ago)
- Last Synced: 2025-04-14T23:07:41.106Z (about 2 months ago)
- Topics: apollo-server, graphql-server, nodejs
- Language: TypeScript
- Homepage:
- Size: 40.2 MB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hawk API
## Start API
For deployment (both in production and in development), you can use Docker.
See Docker instructions [here](DOCKER.md).
Also you can run Hawk API manually:
- Start MongoDB
- Write necessary info to .env file
- Run `yarn start` or `yarn dev`
- Go to `localhost:4000/graphql`
## Schema
GraphQL API schema is located [here](src/typeDefs).
## GraphQL Playground
For queries testing you can enable GraphQL playground.
The corresponding setting is in the `.env` file (`PLAYGROUND_ENABLE`).
If the playground is turned on, you can access it via `/graphql` route.
To execute the request, enter it in the input field on the left and click on the request execution button.
On the right side you will see the result of the query.
## GraphQL Voyager
You can view API Schema visualization in `/voyager` page in your browser. To see current production schema go to [here](https://api.beta.hawk.so/voyager)
## Migrations
Run `yarn migrations:up` command to apply migration revisions or
`yarn migrations:down` to rollback the last revision.