Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.71 KB

README.md

File metadata and controls

56 lines (40 loc) · 1.71 KB

SyncPod-BFF | CircleCI codecov

------------------         -----------------           -------------------
| SyncPod-server |         |  SyncPod-BFF  |           | SyncPod-web-app |
|                | RESTful |               |           |                 |
|                |   API   |               |  GraphQL  |                 |
|                | <------ |               | <-------- |                 |
|     Rails      |         |      Node     |           |      React      |
|                |         |               |   Query   |                 |
|                |  JSON   |               |  Response |                 |
|                | ------> |               | --------> |                 |
|                |         |               |           |                 |
------------------         -----------------           -------------------

Getting started

  1. Install
git clone [email protected]:cyder/SyncPod-BFF.git
cd SyncPod-BFF
yarn install
  1. Start-up server
yarn start
  1. View GraphQL playground
open http://localhost:4000/graphql

Deployment

When publish schema to apollo platform

The schema is published automatically when the master branch is merged. So, don't publish schema from local to apollo platform. However, if there is a bottleneck according to the implementation of BFF, you can directory push schema from local to apollo.

cp .env.sample .env
vim .env # Set ENGINE_API_KEY

yarn serve:dev
yarn publish:schema

Other

COMMING SOON...