Skip to content

Commit fd67965

Browse files
authored
Merge pull request #5 from DaleStudy/contributing
feat: add contributing guide
2 parents a65adfe + 4a7f73c commit fd67965

File tree

3 files changed

+43
-50
lines changed

3 files changed

+43
-50
lines changed

β€Ž.gitignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.env

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# κΈ°μ—¬ κ°€μ΄λ“œ
2+
3+
## 개발 ν™˜κ²½ ꡬ성
4+
5+
Rover CLIκ°€ μ„€μΉ˜λ˜μ–΄ μžˆμ§€ μ•ŠμœΌμ‹œλ‹€λ©΄ μ„€μΉ˜ν•©λ‹ˆλ‹€.
6+
7+
```sh
8+
$ curl -sSL https://rover.apollo.dev/nix/latest | sh
9+
```
10+
11+
`rover config` λͺ…λ Ήμ–΄λ₯Ό 톡해 GraphOS에 인증을 ν•©λ‹ˆλ‹€.
12+
13+
```sh
14+
$ rover config auth
15+
```
16+
17+
ν•„μš”ν•œ ν™˜κ²½ λ³€μˆ˜λ₯Ό μ„€μ •ν•©λ‹ˆλ‹€.
18+
19+
```sh
20+
export GITHUB_API_TOKEN=<κΉƒν—ˆλΈŒ API 토큰>
21+
```
22+
23+
`rover dev` λͺ…λ Ήμ–΄λ₯Ό 톡해 개발용 GraphQL μ„œλ²„λ₯Ό μ˜¬λ¦½λ‹ˆλ‹€.
24+
25+
```sh
26+
$ APOLLO_GRAPH_REF=dalestudy@current \
27+
rover dev --supergraph-config supergraph.yaml --router-config router.yaml
28+
```
29+
30+
`curl` λͺ…λ Ήμ–΄λ‘œ ν…ŒμŠ€νŠΈν•΄λ΄…λ‹ˆλ‹€.
31+
32+
```sh
33+
$ curl --request POST \
34+
--header 'content-type: application/json' \
35+
--url 'https://dalestudy.fly.dev/' \
36+
--data '{"query":"query { __typename }"}'
37+
{"data":{"__typename":"Query"}}%
38+
```

β€ŽREADME.mdβ€Ž

Lines changed: 4 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,6 @@
1-
# Introduction
1+
[![Apollo Check](https://github.com/DaleStudy/graphql/actions/workflows/apollo-check.yml/badge.svg)](https://github.com/DaleStudy/graphql/actions/workflows/apollo-check.yml)
2+
[![Apollo Publish](https://github.com/DaleStudy/graphql/actions/workflows/apollo-publish.yml/badge.svg)](https://github.com/DaleStudy/graphql/actions/workflows/apollo-publish.yml)
23

3-
πŸ‘‹ Welcome!
4+
# GraphQL API
45

5-
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.
6-
7-
# Prerequisites
8-
9-
## Install the Rover CLI
10-
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.
11-
12-
### MacOS/Linux
13-
```
14-
curl -sSL https://rover.apollo.dev/nix/latest | sh
15-
```
16-
17-
### Windows
18-
```
19-
iwr 'https://rover.apollo.dev/win/latest' | iex
20-
```
21-
22-
## Install and configure the recommended extensions
23-
24-
### For schema development
25-
26-
#### VS Code
27-
πŸ”— [Install Apollo's VS Code extension](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo)
28-
πŸ”— [GraphQL development in VS Code](https://www.apollographql.com/docs/graphos/schema-design/ide-support/vs-code)
29-
30-
#### JetBrains
31-
πŸ”— [Install Apollo's JetBrains plugin](https://plugins.jetbrains.com/plugin/20645-apollo-graphql)
32-
πŸ”— [Schema development in JetBrains IDEs](https://www.apollographql.com/docs/graphos/schema-design/ide-support/jetbrains)
33-
34-
#### Vim/NeoVim
35-
πŸ”— [Schema development in Vim and NeoVim](https://www.apollographql.com/docs/graphos/schema-design/ide-support/vim)
36-
37-
### For YAML files
38-
39-
#### VS Code
40-
πŸ”— [Install Red Hat's YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
41-
42-
## Initialize a new project
43-
```
44-
rover init
45-
```
46-
47-
πŸ““ **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.
48-
49-
# Next steps
50-
For further guidance, check out `getting_started.md`. πŸš€
51-
52-
To see more examples of Connectors, check out Apollo's [Connectors Community repo](https://github.com/apollographql/connectors-community).
6+
πŸ§‘β€πŸš€ λ‹¬λ ˆ μŠ€ν„°λ””μ˜ GraphQL API

0 commit comments

Comments
Β (0)