diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4c49bd7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.env diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a16d54b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# 기여 가이드 + +## 개발 환경 구성 + +Rover CLI가 설치되어 있지 않으시다면 설치합니다. + +```sh +$ curl -sSL https://rover.apollo.dev/nix/latest | sh +``` + +`rover config` 명령어를 통해 GraphOS에 인증을 합니다. + +```sh +$ rover config auth +``` + +필요한 환경 변수를 설정합니다. + +```sh +export GITHUB_API_TOKEN=<깃허브 API 토큰> +``` + +`rover dev` 명령어를 통해 개발용 GraphQL 서버를 올립니다. + +```sh +$ APOLLO_GRAPH_REF=dalestudy@current \ + rover dev --supergraph-config supergraph.yaml --router-config router.yaml +``` + +`curl` 명령어로 테스트해봅니다. + +```sh +$ curl --request POST \ + --header 'content-type: application/json' \ + --url 'https://dalestudy.fly.dev/' \ + --data '{"query":"query { __typename }"}' +{"data":{"__typename":"Query"}}% +``` diff --git a/README.md b/README.md index 0e9e4f9..c286632 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,6 @@ -# Introduction +[![Apollo Check](https://github.com/DaleStudy/graphql/actions/workflows/apollo-check.yml/badge.svg)](https://github.com/DaleStudy/graphql/actions/workflows/apollo-check.yml) +[![Apollo Publish](https://github.com/DaleStudy/graphql/actions/workflows/apollo-publish.yml/badge.svg)](https://github.com/DaleStudy/graphql/actions/workflows/apollo-publish.yml) -👋 Welcome! +# GraphQL API -This template repository is used to initialize an API orchestration project using [Apollo’s Rover CLI](https://www.apollographql.com/docs/rover), [Apollo Connectors](https://www.apollographql.com/docs/graphos/schema-design/connectors), and an example REST API, by providing a structured setup for managing and composing APIs efficiently. - -# Prerequisites - -## Install the Rover CLI -Rover is the primary command-line interface for GraphOS—a necessary tool to interact with graphs using Apollo. If you’ve already installed Rover, you can skip this section. - -### MacOS/Linux -``` -curl -sSL https://rover.apollo.dev/nix/latest | sh -``` - -### Windows -``` -iwr 'https://rover.apollo.dev/win/latest' | iex -``` - -## Install and configure the recommended extensions - -### For schema development - -#### VS Code -🔗 [Install Apollo's VS Code extension](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo) -🔗 [GraphQL development in VS Code](https://www.apollographql.com/docs/graphos/schema-design/ide-support/vs-code) - -#### JetBrains -🔗 [Install Apollo's JetBrains plugin](https://plugins.jetbrains.com/plugin/20645-apollo-graphql) -🔗 [Schema development in JetBrains IDEs](https://www.apollographql.com/docs/graphos/schema-design/ide-support/jetbrains) - -#### Vim/NeoVim -🔗 [Schema development in Vim and NeoVim](https://www.apollographql.com/docs/graphos/schema-design/ide-support/vim) - -### For YAML files - -#### VS Code -🔗 [Install Red Hat's YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) - -## Initialize a new project -``` -rover init -``` - -📓 **Note:** If you’re already logged into an existing Apollo organization by the time you run this command, the CLI will nudge you to go to Apollo Studio. From there, you can create a new personal API key to interact with Rover. If you don’t have an account yet, visiting the link will prompt you to create one. - -# Next steps -For further guidance, check out `getting_started.md`. 🚀 - -To see more examples of Connectors, check out Apollo's [Connectors Community repo](https://github.com/apollographql/connectors-community). \ No newline at end of file +🧑‍🚀 달레 스터디의 GraphQL API