|
| 1 | +[English](/contributing.md) | [Українська](docs/contributing/contributing_ua.md) | [Русский](docs/contributing/contributing_ru.md) | [Türkçe](docs/contributing/contributing_tr.md) | [Deutsch](docs/contributing/contributing_de.md) | [Français](docs/contributing/contributing_fr.md) | [Português (BR)](docs/contributing/contributing_pt_br.md) | [বাংলা](docs/contributing/contributing_bn.md) | [Español](docs/contributing/contributing_es.md) | [Română](docs/contributing/contributing_ro.md) | [Polski](docs/contributing/contributing_pl.md) |
| 2 | +| [简体中文](docs/contributing/contributing_cn.md) | [正體中文](docs/contributing/contributing_zhtw.md) | **한국어** |
| 3 | + |
| 4 | +## 함께 Bruno를 더 좋게 만들어요!! |
| 5 | + |
| 6 | +우리는 여러분이 Bruno를 발전시키기 위해 노력해주셔서 기쁩니다. 다음은 여러분의 컴퓨터에서 Bruno를 불러오는 가이드라인입니다. |
| 7 | + |
| 8 | +### 기술 스택 |
| 9 | + |
| 10 | +Bruno는 Next.js와 React로 구축되었습니다. 또한, (로컬 컬렉션을 지원하는) 데스크톱 버전을 제공하기 위해 electron을 사용합니다. |
| 11 | + |
| 12 | +우리가 사용하는 라이브러리 |
| 13 | + |
| 14 | +- CSS - Tailwind |
| 15 | +- Code Editors - Codemirror |
| 16 | +- State Management - Redux |
| 17 | +- Icons - Tabler Icons |
| 18 | +- Forms - formik |
| 19 | +- Schema Validation - Yup |
| 20 | +- Request Client - axios |
| 21 | +- Filesystem Watcher - chokidar |
| 22 | + |
| 23 | +### 의존성 |
| 24 | + |
| 25 | +[Node v18.x 혹은 최신 LTS version](https://nodejs.org/en/)과 npm 8.x 버전이 필요합니다. 우리는 이 프로젝트에서 npm workspaces를 사용합니다. |
| 26 | + |
| 27 | +## 개발 |
| 28 | + |
| 29 | +Bruno는 데스크톱 앱으로 개발되고 있습니다. 한 터미널에서 Next.js를 실행하여 앱을 로드한 다음 다른 터미널에서 electron 앱을 실행해야합니다. |
| 30 | + |
| 31 | +### 로컬 개발 |
| 32 | + |
| 33 | +```bash |
| 34 | +# nodejs 18 버전 사용 |
| 35 | +nvm use |
| 36 | + |
| 37 | +# 의존성 설치 |
| 38 | +npm i --legacy-peer-deps |
| 39 | + |
| 40 | +# packages 빌드 |
| 41 | +npm run build:graphql-docs |
| 42 | +npm run build:bruno-query |
| 43 | +npm run build:bruno-common |
| 44 | + |
| 45 | +# next 앱 실행 (1번 터미널) |
| 46 | +npm run dev:web |
| 47 | + |
| 48 | +# electron 앱 실행 (2번 터미널) |
| 49 | +npm run dev:electron |
| 50 | +``` |
| 51 | + |
| 52 | +### 트러블 슈팅 |
| 53 | + |
| 54 | +`npm install`을 실행할 때, `Unsupported platform` 에러를 마주칠 수 있습니다. 이것을 고치기 위해서는 `node_modules`와 `package-lock.json`을 삭제하고 `npm install`을 실행해야 합니다. |
| 55 | +그러면 앱을 실행하기 위해 필요한 패키지들이 모두 설치됩니다. |
| 56 | + |
| 57 | +```shell |
| 58 | +# 하위 디렉토리에 있는 node_modules 삭제 |
| 59 | +find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do |
| 60 | + rm -rf "$dir" |
| 61 | +done |
| 62 | + |
| 63 | +# 하위 디렉토리에 있는 package-lock 삭제 |
| 64 | +find . -type f -name "package-lock.json" -delete |
| 65 | +``` |
| 66 | + |
| 67 | +### 테스팅 |
| 68 | + |
| 69 | +```bash |
| 70 | +# bruno-schema |
| 71 | +npm test --workspace=packages/bruno-schema |
| 72 | + |
| 73 | +# bruno-lang |
| 74 | +npm test --workspace=packages/bruno-lang |
| 75 | +``` |
| 76 | + |
| 77 | +### Pull Requests 요청 |
| 78 | + |
| 79 | +- PR을 작게 유지하고 한가지에 집중해주세요. |
| 80 | +- 브랜치를 생성하는 형식을 따라주세요. |
| 81 | + - feature/[feature name]: 이 브랜치는 특정 기능에 대한 변경사항이 포함되어야합니다. |
| 82 | + - 예시: feature/dark-mode |
| 83 | + - bugfix/[bug name]: 이 브랜치는 특정 버그에 대한 버그 수정만 포함되어야합니다. |
| 84 | + - 예시: bugfix/bug-1 |
0 commit comments