From 26e2a371597e8559cd90f1e6e4941912aaadb578 Mon Sep 17 00:00:00 2001 From: JeongHyeon Kim Date: Wed, 19 Oct 2022 01:15:08 +0900 Subject: [PATCH 1/4] add: emoji, folding tag --- README-ko.md | 136 ++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 119 insertions(+), 17 deletions(-) diff --git a/README-ko.md b/README-ko.md index 27ae426..6ceb79f 100644 --- a/README-ko.md +++ b/README-ko.md @@ -1,4 +1,6 @@ -# 프로젝트 명 + + +# 프로젝트 이름 + + + +## ⚙ 주요 기능 + +- [x] 구현된 기능 설명 +- [ ] 구현될 기능 설명 + +
+ + + +## 📱 동작 화면 + +https://user-images.githubusercontent.com/25793226/196483866-7e08b079-760d-4d4e-ac90-25f216b80f39.mov + +> 위 영상은 예시이며, 본 프로젝트와는 전혀 관련이 없습니다. + +
+ + + +## 📃 문서 + +- [문서 1](https://www.google.com) +- [문서 2](https://www.google.com) + +
+ + + +## 🛠 개발 + + + +### 📌 기술 스택 + +
+토글 접기 or 펼치기 +
-* [x] 구현된 프로젝트의 기능 설명 -* [ ] 구현되지 않은 프로젝트의 기능 설명 (할 일에 있음) +- 🌐   + ![JavaScript](https://img.shields.io/badge/-JavaScript-333333?style=flat&logo=javascript) + ![TypeScript](https://img.shields.io/badge/-TypeScript-333333?style=flat&logo=typescript) + ![Node.js](https://img.shields.io/badge/-Node.js-333333?style=flat&logo=node.js) + ![NestJs](https://img.shields.io/badge/-NestJs-333333?style=flat&logo=nestjs) + ![GraphQL](https://img.shields.io/badge/-GraphQL-333333?style=flat&logo=graphql) + ![Jest](https://img.shields.io/badge/-Jest-333333?style=flat&logo=jest) + ![TypeORM](https://img.shields.io/badge/-TypeORM-333333?style=flat&logo=typeorm) + ![Flutter](https://img.shields.io/badge/-Flutter-333333?style=flat&logo=flutter) + ![Terraform](https://img.shields.io/badge/-Terraform-333333?style=flat&logo=terraform) + ![AWS](https://img.shields.io/badge/-AWS-333333?style=flat&logo=amazon) +- 🛢   + ![MariaDB](https://img.shields.io/badge/-MariaDB-333333?style=flat&logo=mariadb) + ![Redis](https://img.shields.io/badge/-Redis-333333?style=flat&logo=redis) -## 선행 조건 +
+
-* A 도구가 설치되어 있어야 합니다. -* B 도구가 설치되어 있어야 합니다. + -## 빠른 시작 +### 📌 선행 조건 -프로젝트를 클론합니다: +
+토글 접기 or 펼치기 +
+ +- A 도구가 설치되어 있어야 합니다. +- B 도구가 설치되어 있어야 합니다. + +
+
+ + + +### 📌 빠른 시작 + +
+토글 접기 or 펼치기 +
+ +① 프로젝트를 클론합니다: ```sh git clone ~~~.git cd ~~~ ``` -실행합니다: +② 실행합니다: ```sh run ~~~ ``` -### 테스트 방법 +
+
+ + + +### 📌 테스트 방법 + +
+토글 접기 or 펼치기 +
```sh do test ~~~ get test:coverage ~~~ ``` -## 질문 +
+
+ +
+ + + +## 💁‍♂️ 질문 + +질문이나 도움이 필요하신 분들은 [공식 디스코드 채널](https://여러분의_디스코드_채널_초대_주소)을 이용 부탁드립니다. 프로젝트의 이슈 목록은 기능 추가 요청이나 버그 제보용으로만 사용됩니다. + +
+ + + +## 🤝🏻 기여 + +프로젝트에 기여해주신 고마운 분들: + +- [rhea-so](https://github.com/rhea-so) + +
-질문이나 도움이 필요하신 분들은 [Discord channel](YOU CAN USE ANOTHER SNS)를 이용 부탁드립니다. 프로젝트의 이슈 목록은 기능 추가 요청이나 버그 제보용으로만 사용됩니다. + -## 기여 방법 +## 📝 라이선스 -[CONTRIBUTING.md](CONTRIBUTING.md File Path)를 읽고, 작업 후 PR을 보내주시길 부탁드립니다. +프로젝트에는 [MIT](./LICENSE) 라이선스가 적용되어있습니다. -## 라이선스 +
-프로젝트에는 [MIT](LICENSE File Path) 라이선스가 적용되어있습니다. + From 461e740aa6121ef89e1c93f64e0d87bdf3d7c59f Mon Sep 17 00:00:00 2001 From: JeongHyeon Kim Date: Wed, 19 Oct 2022 01:22:18 +0900 Subject: [PATCH 2/4] add: english version --- README.md | 140 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 121 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f2fe839..ea43745 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,159 @@ + + # Project Title - + - + ![Project Contributors](https://img.shields.io/github/contributors/rhea-so-lab/Good-README.md-Template) ![Project License](https://img.shields.io/github/license/rhea-so-lab/Good-README.md-Template) -One Paragraph of project description goes here. +One Paragraph of project description goes here + +
+ + + +## ⚙ Features + +- [x] One Feature of project goes here. And this is finished +- [ ] One Feature of project goes here. And this is unfinished + +
+ + + +## 📱 Working + +https://user-images.githubusercontent.com/25793226/196483866-7e08b079-760d-4d4e-ac90-25f216b80f39.mov + +> The above video is an example and has nothing to do with this project + +
+ + + +## 📃 Documents + +- [Document A](https://www.google.com) +- [Document B](https://www.google.com) + +
+ + + +## 🛠 Development + + + +### 📌 Tech stacks -## Features +
+Open or Close +
-* [x] One Feature of project goes here. And this is finished. -* [ ] One Feature of project goes here. And this is unfinished. +- 🌐   + ![JavaScript](https://img.shields.io/badge/-JavaScript-333333?style=flat&logo=javascript) + ![TypeScript](https://img.shields.io/badge/-TypeScript-333333?style=flat&logo=typescript) + ![Node.js](https://img.shields.io/badge/-Node.js-333333?style=flat&logo=node.js) + ![NestJs](https://img.shields.io/badge/-NestJs-333333?style=flat&logo=nestjs) + ![GraphQL](https://img.shields.io/badge/-GraphQL-333333?style=flat&logo=graphql) + ![Jest](https://img.shields.io/badge/-Jest-333333?style=flat&logo=jest) + ![TypeORM](https://img.shields.io/badge/-TypeORM-333333?style=flat&logo=typeorm) + ![Flutter](https://img.shields.io/badge/-Flutter-333333?style=flat&logo=flutter) + ![Terraform](https://img.shields.io/badge/-Terraform-333333?style=flat&logo=terraform) + ![AWS](https://img.shields.io/badge/-AWS-333333?style=flat&logo=amazon) +- 🛢   + ![MariaDB](https://img.shields.io/badge/-MariaDB-333333?style=flat&logo=mariadb) + ![Redis](https://img.shields.io/badge/-Redis-333333?style=flat&logo=redis) -## Prerequisites +
+
-* Need Tool A -* Need Tool B + -## Quick Start +### 📌 Prerequisites -Cloning the project: +
+Open or Close +
+ +- Need Tool A +- Need Tool B + +
+
+ + + +### 📌 Quick Start + +
+Open or Close +
+ +① Cloning the project: ```sh git clone ~~~.git cd ~~~ ``` -Run: +② Run: ```sh run ~~~ ``` -### Testing +
+
+ + + +### 📌 Testing + +
+Open or Close +
```sh do test ~~~ get test:coverage ~~~ ``` -## Question +
+
+ +
+ + + +## 💁‍♂️ Question + +For questions and support please use the official [Official Discord Channel](https://DISCORD_CHANNEL_INVITE_LINK), The issue list of this repo is exclusively for bug reports and feature requests + +
+ + + +## 🤝🏻 Contribute + +Thank you for contributing to the project: + +- [rhea-so](https://github.com/rhea-so) + +
-For questions and support please use the official [Discord channel](YOU CAN USE ANOTHER SNS). The issue list of this repo is exclusively for bug reports and feature requests. + -## Contributing +## 📝 License -Please read [CONTRIBUTING.md](CONTRIBUTING.md File Path) for details on our code of conduct, and the process for submitting pull requests to us. +This Project is [MIT](./LICENSE) Licensed -## License +
-Project is [MIT licensed](LICENSE File Path). + From ff8b0d307876fe08888d511b9711266206ea998a Mon Sep 17 00:00:00 2001 From: JeongHyeon Kim Date: Wed, 19 Oct 2022 01:23:42 +0900 Subject: [PATCH 3/4] =?UTF-8?q?fix:=20ko=20=E2=86=92=20kr?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-ko.md => README-kr.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README-ko.md => README-kr.md (100%) diff --git a/README-ko.md b/README-kr.md similarity index 100% rename from README-ko.md rename to README-kr.md From 3b1ce0a66045b58a0729978b08469582bafe1c31 Mon Sep 17 00:00:00 2001 From: JeongHyeon Kim Date: Wed, 19 Oct 2022 01:30:11 +0900 Subject: [PATCH 4/4] add: jp --- README-jp.md | 159 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 159 insertions(+) create mode 100644 README-jp.md diff --git a/README-jp.md b/README-jp.md new file mode 100644 index 0000000..019d8c9 --- /dev/null +++ b/README-jp.md @@ -0,0 +1,159 @@ + + +# プロジェクト名 + + + + + +![Project Contributors](https://img.shields.io/github/contributors/rhea-so-lab/Good-README.md-Template) +![Project License](https://img.shields.io/github/license/rhea-so-lab/Good-README.md-Template) + +ここでプロジェクトを簡単に説明してください。 + +
+ + + +## ⚙ 主要機能 + +- [x] 実装された機能説明 +- [ ] 実装される機能説明 + +
+ + + +## 📱 動作画面 + +https://user-images.githubusercontent.com/25793226/196483866-7e08b079-760d-4d4e-ac90-25f216b80f39.mov + +> 上記の映像は例であり、本プロジェクトとは全く関係ありません。 + +
+ + + +## 📃 文書 + +- [文書 1](https://www.google.com) +- [文書 2](https://www.google.com) + +
+ + + +## 🛠 開発 + + + +### 📌 技術スタック + +
+Open or Close +
+ +- 🌐   + ![JavaScript](https://img.shields.io/badge/-JavaScript-333333?style=flat&logo=javascript) + ![TypeScript](https://img.shields.io/badge/-TypeScript-333333?style=flat&logo=typescript) + ![Node.js](https://img.shields.io/badge/-Node.js-333333?style=flat&logo=node.js) + ![NestJs](https://img.shields.io/badge/-NestJs-333333?style=flat&logo=nestjs) + ![GraphQL](https://img.shields.io/badge/-GraphQL-333333?style=flat&logo=graphql) + ![Jest](https://img.shields.io/badge/-Jest-333333?style=flat&logo=jest) + ![TypeORM](https://img.shields.io/badge/-TypeORM-333333?style=flat&logo=typeorm) + ![Flutter](https://img.shields.io/badge/-Flutter-333333?style=flat&logo=flutter) + ![Terraform](https://img.shields.io/badge/-Terraform-333333?style=flat&logo=terraform) + ![AWS](https://img.shields.io/badge/-AWS-333333?style=flat&logo=amazon) +- 🛢   + ![MariaDB](https://img.shields.io/badge/-MariaDB-333333?style=flat&logo=mariadb) + ![Redis](https://img.shields.io/badge/-Redis-333333?style=flat&logo=redis) + +
+
+ + + +### 📌 先行条件 + +
+Open or Close +
+ +- Aツールがインストールされている必要があります。 +- Bツールがインストールされている必要があります。 + +
+
+ + + +### 📌 早いスタート + +
+Open or Close +
+ +① プロジェクトをクローンします: + +```sh +git clone ~~~.git +cd ~~~ +``` + +② 実行します: + +```sh +run ~~~ +``` + +
+
+ + + +### 📌 テスト方法 + +
+Open or Close +
+ +```sh +do test ~~~ +get test:coverage ~~~ +``` + +
+
+ +
+ + + +## 💁‍♂️ 質問 + +ご質問やお手伝いが必要な方は公式[ディスコードチャンネル](https://皆さんのディスコードチャンネルアドレス)をご利用ください。プロジェクトのイシューリストは、機能追加リクエストやバグ情報用にのみ使用されます。 + +
+ + + +## 🤝🏻 寄与 + +プロジェクトに貢献してくださったありがたい方々: + +- [rhea-so](https://github.com/rhea-so) + +
+ + + +## 📝 ライセンス + +プロジェクトには[MIT](./LICENSE)ライセンスが適用されています。 + +
+ +