Skip to content

Commit d3271e2

Browse files
justinyoojustinyoo
authored
Update docs (microsoft#6)
* Add 05-containerization.md with custom instructions * Update all README files * Update docs
1 parent dc92c93 commit d3271e2

File tree

26 files changed

+414
-1619
lines changed

26 files changed

+414
-1619
lines changed

‎README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,13 @@ This is a self-paced workshop by following the links below:
7575

7676
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.
7777

78-
| Language | Location |
79-
|------------|-----------------------------|
80-
| Python | [python](./python/) |
81-
| JavaScript | [javascript](./javascript/) |
82-
| Java | [java](./java/) |
83-
| .NET | [dotnet](./dotnet/) |
78+
| Language | Location |
79+
|------------------|--------------------------------------|
80+
| Python | [python](./complete/python/) |
81+
| JavaScript | [javascript](./complete/javascript/) |
82+
| Java | [java](./complete/java/) |
83+
| .NET | [dotnet](./complete/dotnet/) |
84+
| Containerization | [containerization](./complete/) |
8485

8586
## Read More...
8687

‎complete/README.md‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,38 @@
1-
# 컨테이너 오케스트레이션
1+
# Complete App Samples
22

3-
## 시작하기
3+
Here are the list of complete app samples. Because they are also vibe-coded, you can check out how they're built.
44

5-
1. Docker Desktop 이 현재 동작중인지 확인합니다.
5+
| Application | Location |
6+
|-------------|-----------------------------|
7+
| FastAPI | [python](./python/) |
8+
| React | [javascript](./javascript/) |
9+
| Spring Boot | [java](./java/) |
10+
| Blazor | [dotnet](./dotnet/) |
11+
12+
## Containerization Sample
13+
14+
### Prerequisites
15+
16+
Refer to the [README](../README.md) doc for preparation.
17+
18+
### Getting Started
19+
20+
1. Make sure that Docker Desktop is running.
621

722
```bash
823
docker info
924
```
1025

11-
1. 아래 명령어를 실행시켜 준비된 컨테이너 앱을 실행시킵니다.
26+
1. Run the containerized apps.
1227

1328
```bash
1429
docker compose up -d
1530
```
1631

17-
1. 웹 브라우저를 열고 `http://localhost:3000`으로 접속하여 웹사이트가 제대로 동작하는지 확인합니다.
18-
32+
1. Open a web browser and navigate to `http://localhost:3000`.
33+
1. Verify if the web application is running properly.
1934
1. 아래 명령어를 실행시켜 컨테이너 앱을 삭제합니다.
2035

21-
```bash
22-
docker compose down --rmi all
23-
```
36+
```bash
37+
docker compose down --rmi all
38+
```

complete/docker-compose.yaml renamed to complete/compose.yaml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,28 @@
11
services:
2-
contoso-java:
2+
contoso-backend:
33
build:
44
context: .
55
dockerfile: Dockerfile.java
6-
container_name: contoso-java
6+
container_name: contoso-backend
77
ports:
88
- "5050:8080"
9-
volumes:
10-
- ./java/demo/sns.db:/app/sns.db
119
networks:
1210
- contoso
1311

14-
contoso-dotnet:
12+
contoso-frontend:
1513
build:
1614
context: .
1715
dockerfile: Dockerfile.dotnet
18-
container_name: contoso-dotnet
16+
container_name: contoso-frontend
1917
ports:
2018
- "3000:8080"
2119
depends_on:
22-
- contoso-java
20+
- contoso-backend
2321
environment:
24-
- ApiBaseUrl=http://contoso-java:8080
22+
- ApiBaseUrl=http://contoso-backend:8080
2523
networks:
2624
- contoso
2725

2826
networks:
2927
contoso:
30-
name: contoso
28+
name: contoso

‎complete/dotnet/README.md‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# .NET 앱 완성본
1+
# .NET App Sample
22

3-
## 시작하기
3+
## Prerequisites
44

5-
### Java 백엔드 시작하기
5+
Refer to the [README](../../README.md) doc for preparation.
66

7-
[Java 백엔드 완성본 앱](../complete/java/) 문서를 참조하여 실행시킵니다.
7+
## Getting Started
88

9-
### .NET 프론트엔드 시작하기
9+
### Run Spring Boot Backend
1010

11-
1. 리포지토리 루트를 확인합니다.
11+
Use [Java App Sample](../complete/java/).
12+
13+
### Run Blazor Frontend
14+
15+
1. Get the repository root.
1216

1317
```bash
1418
# bash/zsh
@@ -20,12 +24,10 @@
2024
$REPOSITORY_ROOT = git rev-parse --show-toplevel
2125
```
2226

23-
1. 앱을 실행시킵니다.
27+
1. Run the app.
2428

2529
```bash
26-
dotnet run --project $REPOSITORY_ROOT/complete/dotnet/ContosoSnsWebApp/ContosoSnsWebApp.csproj
30+
dotnet watch run --project $REPOSITORY_ROOT/complete/dotnet/Contoso.BlazorApp/Contoso.BlazorApp.csproj
2731
```
2832

29-
1. 터미널에 보이는 `http://localhost:5090` 링크를 `Ctrl` + 왼쪽 마우스 클릭(윈도우) 또는 `Cmd` + 왼쪽 마우스 클릭(맥 OS)으로 클릭하여 웹 브라우저로 접속합니다.
30-
31-
1. 웹 애플리케이션이 정상적으로 동작하는 것을 확인합니다.
33+
1. Verify if the web application is running properly.

‎complete/java/README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
# Java 앱 완성본
1+
# Java App Sample
22

3-
## 시작하기
3+
## Prerequisites
44

5-
TBD
5+
Refer to the [README](../../README.md) doc for preparation.
6+
7+
## Getting Started
8+
9+
### Run Spring Boot Backend

‎complete/javascript/README.md‎

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,41 @@
1-
# JavaScript React 앱
1+
# JavaScript App Sample
22

3-
## 사용 기술
4-
- React
5-
- Vite
6-
- Tailwind CSS
7-
- Yarn 패키지 매니저
3+
## Prerequisites
84

9-
## 시작하기
5+
Refer to the [README](../../README.md) doc for preparation.
106

11-
### 필요 조건
12-
- Node.js (14.x 이상)
7+
## Getting Started
138

14-
### 설치 및 실행
15-
```bash
16-
# 의존성 설치
17-
yarn install
9+
### Run FastAPI Backend
1810

19-
# 개발 서버 실행
20-
yarn dev
11+
Use [Python App Sample](../complete/python/).
2112

22-
# 프로덕션 빌드
23-
yarn build
13+
### Run React Frontend
2414

25-
# 빌드 미리보기
26-
yarn preview
27-
```
15+
1. Get the repository root.
16+
17+
```bash
18+
# bash/zsh
19+
REPOSITORY_ROOT=$(git rev-parse --show-toplevel)
20+
```
21+
22+
```powershell
23+
# PowerShell
24+
$REPOSITORY_ROOT = git rev-parse --show-toplevel
25+
```
26+
27+
1. Install npm packages.
28+
29+
```bash
30+
cd $REPOSITORY_ROOT
31+
npm install
32+
```
33+
34+
1. Run the app.
35+
36+
```bash
37+
npm run start
38+
```
39+
40+
1. Open a web browser and navigate to `http://localhost:3000`.
41+
1. Verify if the web application is running properly.

‎complete/python/README.md‎

Lines changed: 5 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,9 @@
1-
# Python 앱 완성본
1+
# Python App Sample
22

3-
## 시작하기
4-
5-
### 환경설정 방법
6-
7-
1. 터미널을 실행합니다.
8-
2. 아래 명령어를 순서대로 실행합니다.
9-
10-
```
11-
git clone https://github.com/devrel-kr/github-copilot-bootcamp-2025.git
12-
cd github-copilot-bootcamp-2025
13-
cd python
14-
python -m venv .venv
15-
source .venv/bin/activate
16-
pip install -r requirements.txt
17-
```
18-
19-
### 실행 방법
20-
21-
1. 터미널에서 아래 명령어를 수행합니다.
22-
23-
```
24-
uvicorn main:app --reload
25-
```
26-
27-
2. 아래와 같은 로그가 출력이 되면 정상적으로 실행이 된 것입니다.
28-
29-
```
30-
INFO: Will watch for changes in these directories: ['/???/github-copilot-bootcamp-2025/python']
31-
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
32-
INFO: Started reloader process [85427] using StatReload
33-
INFO: Started server process [85430]
34-
INFO: Waiting for application startup.
35-
INFO: Application startup complete.
36-
```
37-
38-
## 사용해보기
39-
40-
http://127.0.0.1:8000 에 접속하면 간단한 SNS 서비스를 사용해볼 수 있습니다. 간단한 프론트엔드가 함께 포함되어 있습니다. 배포된 데모 서비스는 아래와 같습니다.
41-
42-
[데모 웹서비스](https://simplesns-axeyhcbsfnfscfe9.koreasouth-01.azurewebsites.net/)
43-
44-
http://127.0.0.1:8000/docs 에 접속하면, Swagger UI 기반의 API 문서를 확인할 수 있습니다. 이 페이지에서는 모든 API 엔드포인트를 확인하고 직접 테스트해볼 수 있습니다.
45-
46-
[데모 Swagger UI 서비스](https://simplesns-axeyhcbsfnfscfe9.koreasouth-01.azurewebsites.net/docs)
3+
## Prerequisites
474

5+
Refer to the [README](../../README.md) doc for preparation.
486

7+
## Getting Started
498

9+
### Run FastAPI Backend

‎docs/00-setup.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Refer to the [README](../README.md) doc for preparation.
1717
- [Install Visual Studio Code](#install-visual-studio-code)
1818
- [Start Visual Studio Code](#start-visual-studio-code)
1919
- [Check GitHub Copilot Agent Mode](#check-github-copilot-agent-mode)
20+
- [Prepare Custom Instructions](#prepare-custom-instructions)
2021
- [Analyze Product Requirements Document (PRD) and Design API](#analyze-product-requirements-document-prd-and-design-api)
2122

2223
## Use GitHub Codespaces
@@ -267,7 +268,7 @@ Refer to the [README](../README.md) doc for preparation.
267268
268269
1. Select model to either `GPT-4.1` or `Claude Sonnet 4`.
269270
270-
## Analyze Product Requirements Document (PRD) and Design API
271+
## Prepare Custom Instructions
271272
272273
1. Set the environment variable of `$REPOSITORY_ROOT`.
273274
@@ -295,7 +296,9 @@ Refer to the [README](../README.md) doc for preparation.
295296
-Destination $REPOSITORY_ROOT/.github/ -Recurse -Force
296297
```
297298
298-
1. Make sure that you're using GitHub Copilot Agent Mode.
299+
## Analyze Product Requirements Document (PRD) and Design API
300+
301+
1. Make sure that you're using GitHub Copilot Agent Mode with the model of `Claude Sonnet 4` or `GPT-4.1`.
299302
1. Add [`product-requirements.md`](../product-requirements.md) to GitHub Copilot.
300303
1. Enter the prompt like the following for GitHub Copilot Agent to generate an OpenAPI document for you. This OpenAPI document will be the base of your entire application.
301304

0 commit comments

Comments
 (0)