Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.03 KB

README.md

File metadata and controls

31 lines (22 loc) · 1.03 KB
Raw

Hawk API

Start API

For deployment (both in production and in development), you can use Docker. See Docker instructions here.

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.

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

Migrations

Run yarn migrations:up command to apply migration revisions or yarn migrations:down to rollback the last revision.