Skip to content

Commit 7a705ae

Browse files
justinyoojustinyoo
committed
Update README
1 parent 1fa850a commit 7a705ae

3 files changed

Lines changed: 358 additions & 171 deletions

File tree

‎README.md‎

Lines changed: 56 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,92 @@
1-
# GitHub Copilot Bootcamp 2025
1+
# GitHub Copilot Vibe Coding Workshop
22

3-
[GitHub Copilot](https://docs.github.com/ko/copilot/about-github-copilot/what-is-github-copilot)의 최신 기능을 이용해서 다양한 언어로 다양한 애플리케이션을 개발해 봅시다. 진정한 vibe coding에 올라타 보세요!
3+
Let's vibe-code with [GitHub Copilot](https://docs.github.com/copilot/about-github-copilot/what-is-github-copilot) and its newest and greatest features in various programming languages such as Python, JavaScript, Java and .NET, as well as make the apps cloud-native by containerization. Are you ready to jump in?
44

5-
## 시나리오
5+
## Background
66

7-
Contoso 아웃도어 컴파니는 회사의 다양한 아웃도어용 제품 홍보를 위한 마이크로 소셜미디어 사이트를 개발하려고 합니다. 현재 개발 부서에는 Python 개발자가 백엔드 API를, JavaScript 개발자가 프론트엔드 웹 UI를 담당하고 있습니다. 마케팅 팀에서는 기본적인 MVP를 제작해서 웹사이트를 론칭할 계획을 세웠습니다. 하지만, 개발 기간이 촉박해서 빠르게 제작을 해야 하는 상황입니다.
7+
Contoso is a company that sells products for various outdoor activities. A marketing department of Contoso would like to launch a micro social media website to promote their products for existing and potential customers. As their first MVP, the want to quickly build the website. The IT department of Contoso currently has two developers using Python and JavaScript respectively. The launch date is fast approaching, so both developers should quickly deliver the application.
88

9-
앗, 그런데 말입니다...
9+
But here's the situation...
1010

11-
## 워크샵 목표
11+
## Workshop Objectives
1212

13-
- GitHub Copilot의 다양한 기능을 활용해서 애플리케이션을 개발할 수 있습니다.
14-
- GitHub Copilot의 Agent 모드를 이용해서 애플리케이션을 개발할 수 있습니다.
15-
- GitHub Copilot에 사용자 지정 지침(Custom Instructions)을 추가하여 좀 더 정확하게 애플리케이션을 개발할 수 있습니다.
16-
- GitHub Copilot에 다양한 MCP 서버를 추가하여 좀 더 정확하게 애플리케이션을 개발할 수 있습니다.
13+
- Build applications using GitHub Copilot Agent Mode.
14+
- Add custom instruction to GitHub Copilot so that you have more control over GitHub Copilot.
15+
- Add various MCP servers to GitHub Copilot에 so that you build the applications more precisely.
1716

18-
## 워크샵 사전 준비사항
17+
## Prerequisites
1918

20-
[GitHub Codespaces](https://docs.github.com/ko/codespaces/about-codespaces/what-are-codespaces)를 활용할 경우, 크로미움 계열의 웹 브라우저만 있으면 됩니다. 다만, 로컬 PC에서 직접 개발할 경우, 아래와 같은 내용을 직접 준비해야 합니다.
19+
During this workshop, [GitHub Codespaces](https://docs.github.com/ko/codespaces/about-codespaces/what-are-codespaces) is highly recommended because there's no need for preparation, except a web browser. However, if you really need to use your machine, make sure you've installed everything identified below.
2120

22-
### 공통
21+
### Common
2322

24-
- [Visual Studio Code](https://code.visualstudio.com/) 설치
25-
- VS Code [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) 익스텐션 설치
26-
- VS Code [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) 익스텐션 설치
27-
- 💥 Windows 사용자용 👉 [PowerShell 7](https://learn.microsoft.com/powershell/scripting/install/installing-powershell) 설치
28-
- [git CLI](https://git-scm.com/downloads) 설치
29-
- [GitHub CLI](https://cli.github.com/) 설치
30-
- [Docker Desktop](https://docs.docker.com/get-started/introduction/get-docker-desktop/) 설치
23+
- [Visual Studio Code](https://code.visualstudio.com/)
24+
- VS Code [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) Extension
25+
- VS Code [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) Extension
26+
- 💥 For Windows users 👉 [PowerShell 7](https://learn.microsoft.com/powershell/scripting/install/installing-powershell)
27+
- [git CLI](https://git-scm.com/downloads)
28+
- [GitHub CLI](https://cli.github.com/)
29+
- [Docker Desktop](https://docs.docker.com/get-started/introduction/get-docker-desktop/)
3130

3231
### Python
3332

34-
- [pyenv](https://github.com/pyenv/pyenv) 또는 [pyenv for Windows](https://github.com/pyenv-win/pyenv-win) 설치
35-
- pyenv를 통한 Python 3.12+ 이상 설치
36-
- VS Code [Python](https://marketplace.visualstudio.com/items/?itemName=ms-python.python) 익스텐션 설치
37-
- VS Code [Pylance](https://marketplace.visualstudio.com/items/?itemName=ms-python.vscode-pylance) 익스텐션 설치
38-
- VS Code [Python Debugger](https://marketplace.visualstudio.com/items/?itemName=ms-python.debugpy) 익스텐션 설치
39-
- VS Code [autopep8](https://marketplace.visualstudio.com/items/?itemName=ms-python.autopep8) 익스텐션 설치
33+
- [pyenv](https://github.com/pyenv/pyenv) or [pyenv for Windows](https://github.com/pyenv-win/pyenv-win)
34+
- Python 3.12+ through pyenv
35+
- VS Code [Python](https://marketplace.visualstudio.com/items/?itemName=ms-python.python) Extension
36+
- VS Code [Pylance](https://marketplace.visualstudio.com/items/?itemName=ms-python.vscode-pylance) Extension
37+
- VS Code [Python Debugger](https://marketplace.visualstudio.com/items/?itemName=ms-python.debugpy) Extension
38+
- VS Code [autopep8](https://marketplace.visualstudio.com/items/?itemName=ms-python.autopep8) Extension
4039

4140
### JavaScript
4241

43-
- [nvm](https://github.com/nvm-sh/nvm) 또는 [nvm for Windows](https://github.com/coreybutler/nvm-windows) 설치
44-
- nvm을 통한 [Node.js](https://nodejs.org/) 최신 LTS 버전 설치
42+
- [nvm](https://github.com/nvm-sh/nvm) or [nvm for Windows](https://github.com/coreybutler/nvm-windows)
43+
- The latest LTS of [Node.js](https://nodejs.org/) through nvm
4544

4645
### Java
4746

48-
- [SDKMAN](https://sdkman.io/) 설치
49-
- SDKMAN을 통한 [OpenJDK 21](https://learn.microsoft.com/java/openjdk/download) 설치
50-
- VS Code [Extension Pack for Java](https://marketplace.visualstudio.com/items/?itemName=vscjava.vscode-java-pack) 익스텐션 설치
51-
- VS Code [Spring Boot Extension Pack](https://marketplace.visualstudio.com/items/?itemName=vmware.vscode-boot-dev-pack) 익스텐션 설치
47+
- [SDKMAN](https://sdkman.io/)
48+
- [OpenJDK 21](https://learn.microsoft.com/java/openjdk/download) through SDKMAN
49+
- VS Code [Extension Pack for Java](https://marketplace.visualstudio.com/items/?itemName=vscjava.vscode-java-pack) Extension
50+
- VS Code [Spring Boot Extension Pack](https://marketplace.visualstudio.com/items/?itemName=vmware.vscode-boot-dev-pack) Extension
5251

5352
### .NET
5453

55-
- [.NET SDK 9](https://dotnet.microsoft.com/download/dotnet/9.0) 설치
56-
- [VS Code C# Dev Kit](https://marketplace.visualstudio.com/items/?itemName=ms-dotnettools.csdevkit) 익스텐션 설치
54+
- [.NET SDK 9](https://dotnet.microsoft.com/download/dotnet/9.0)
55+
- [VS Code C# Dev Kit](https://marketplace.visualstudio.com/items/?itemName=ms-dotnettools.csdevkit) Extension
5756

58-
## 작업 문서
57+
## Product Requirements Document
5958

60-
아래 문서를 통해 자기주도학습의 형태로 직접 애플리케이션을 개발해 보세요!
59+
First and the foremost place for you to start is this [PRD (Product Requirements Document)](./product-requirements.md). This document will give you better understanding what todo and how to do.
6160

62-
| 순서 | 링크 |
63-
|------------------------|---------------------------------------------|
64-
| 00: 개발 환경 설정 | [00-setup.md](./docs/00-setup.md) |
65-
| 01: Python 앱 개발 | [01-python.md](./docs/01-python.md) |
66-
| 02: JavaScript 앱 개발 | [02-javascript.md](./docs/02-javascript.md) |
67-
| 03: Java 앱 개발 | [03-java.md](./docs/03-java.md) |
68-
| 04: .NET 앱 개발 | [04-dotnet.md](./docs/04-dotnet.md) |
61+
## Workshop Instructions
6962

70-
## 완성본 예제 보기
63+
This is a self-paced workshop by following the links below:
7164

72-
모든 샘플 코드의 완성본 예제는 각 언어별 디렉토리에 있습니다. 하지만, 이는 GitHub Copilot으로 개발한 애플리케이션의 예시일 뿐 항상 이와 똑같이 만들어지는 것은 아닙니다.
65+
| Step | Link |
66+
|------------------------------------|---------------------------------------------------------|
67+
| 00: Development Environment | [00-setup.md](./docs/00-setup.md) |
68+
| 01: Python Backend | [01-python.md](./docs/01-python.md) |
69+
| 02: JavaScript Frontend | [02-javascript.md](./docs/02-javascript.md) |
70+
| 03: Java Migration from Python | [03-java.md](./docs/03-java.md) |
71+
| 04: .NET Migration from JavaScript | [04-dotnet.md](./docs/04-dotnet.md) |
72+
| 05: Containerization | [05-containerization.md](./docs/05-containerization.md) |
7373

74-
| 언어 | 디렉토리 |
74+
## Complete Samples
75+
76+
Check out the complete example of each application. They're also vibe-coded with GitHub Copilot, therefore, they might not be perfect, and you don't have to follow the app.
77+
78+
| Language | Location |
7579
|------------|-----------------------------|
7680
| Python | [python](./python/) |
7781
| JavaScript | [javascript](./javascript/) |
7882
| Java | [java](./java/) |
7983
| .NET | [dotnet](./dotnet/) |
8084

81-
## `openapi.yaml` 문서에 대하여...
82-
83-
`openapi.yaml` 파일은 우리가 만들 웹 API의 설계도라고 생각하면 좋습니다. 마치 건물을 짓기 전에 건축 도면이 필요한 것처럼, API를 개발하기 전에 이 파일로 전체 구조를 미리 계획합니다.
84-
85-
이 파일에서는 다음과 같은 내용을 정의합니다:
86-
87-
- 어떤 기능들(포스트 작성, 댓글 달기, 좋아요 등)을 만들지,
88-
- 각 기능을 사용하려면 어떤 주소(URL)로 요청해야 하는지,
89-
- 요청할 때 어떤 정보가 필요한지(예: 포스트 내용, 사용자 이름),
90-
- 요청 후 어떤 응답이 돌아오는지
91-
92-
초보자에게 가장 큰 장점은:
93-
94-
- 개발 전에 API 구조를 명확히 볼 수 있어 전체 그림을 이해하기 쉽습니다.
95-
- 여러 개발자가 같은 규칙으로 작업할 수 있습니다.
96-
- 자동으로 API 문서와 테스트 페이지가 생성됩니다.
97-
- 클라이언트(앱이나 웹) 개발자와 서버 개발자 간의 소통이 쉬워집니다.
85+
## Read More...
9886

99-
마치 레고 조립 설명서처럼, 어떤 부품이 어디에 들어가는지 미리 알려주는 역할을 합니다.
100-
101-
`openapi.yaml`은 SNS 앱을 위한 API 설계도로, 다음 기능들을 정의합니다:
102-
103-
- 포스트 관련 API (5개)
104-
- 포스트 목록 조회, 작성, 상세 조회, 수정, 삭제
105-
- 댓글 관련 API (5개)
106-
- 댓글 목록 조회, 작성, 상세 조회, 수정, 삭제
107-
- 좋아요 관련 API (2개)
108-
- 좋아요 추가, 취소
109-
110-
각 API는 필요한 요청 정보와 응답 형식, 오류 처리 방법을 명확히 정의하고 있어 개발 시 일관성 있는 인터페이스를 구현할 수 있습니다.
111-
112-
## 참고 자료
113-
114-
- [GitHub Copilot 에이전트 모드 및 MCP](https://code.visualstudio.com/blogs/2025/04/07/agentMode)
115-
- [GitHub Copilot 사용자 정의 지침(Custom Instructions)](https://code.visualstudio.com/docs/copilot/copilot-customization)
116-
- [GitHub Copilot AI 모델 바꾸기](https://docs.github.com/ko/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat?tool=vscode)
117-
- [GitHub Copilot](https://docs.github.com/ko/copilot/about-github-copilot/what-is-github-copilot)
11887
- [GitHub Codespaces](https://docs.github.com/ko/codespaces/about-codespaces/what-are-codespaces)
88+
- [GitHub Copilot](https://docs.github.com/ko/copilot/about-github-copilot/what-is-github-copilot)
89+
- [GitHub Copilot: Agent Mode](https://code.visualstudio.com/blogs/2025/04/07/agentMode)
90+
- [GitHub Copilot: MCP](https://code.visualstudio.com/blogs/2025/05/12/agent-mode-meets-mcp)
91+
- [GitHub Copilot: Custom Instructions](https://code.visualstudio.com/docs/copilot/copilot-customization)
92+
- [GitHub Copilot: Changing AI Models](https://docs.github.com/ko/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat?tool=vscode)

0 commit comments

Comments
 (0)