Skip to content

Commit cc79b44

Browse files
committed
[ADD] 한국어 README 추가
1 parent c24d7ec commit cc79b44

File tree

2 files changed

+44
-4
lines changed

2 files changed

+44
-4
lines changed

Diff for: README-ko.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
💬 Nest.js로 인증을 구현하고자 하는 분들을 위한 핵심적인 가이드북입니다.</br></br>
2+
3+
## Nest.js + Mongoose 인증 서비스
4+
`Nest.js` `Mongoose` `JWT` </br>
5+
백엔드를 모르는 분들과 Nest.js를 처음 접하는 분들이 쉽게 배울 수 있는 프로젝트입니다. </br>
6+
7+
리드미에 상세한 설명을 적어두었고 친절한 주석을 달기 위해 노력했습니다.</br>
8+
저는 이 프로젝트가 Nest.js를 처음 시작하는 사람들에게 일종의 '교과서'가 되길 바랍니다.
9+
언제나 피드백은 환영이며, 질문을 남겨주셔도 좋습니다. </br></br>
10+
11+
## 프로젝트 대상
12+
- 백엔드를 처음 공부하고 싶은 학생
13+
- 백엔드 개발을 경험해보고 싶은 프론트엔드 개발자
14+
- Nest.js가 궁금한 타 언어 백엔드 개발자 </br></br>
15+
16+
## 왜 이 프로젝트가 중요할까요?
17+
1. Nest 프로젝트를 처음 시작하고 가이드가 필요한 사람에게 도움이 될 수 있습니다.
18+
2. 인증과 관련된 기본 지식을 이해할 수 있습니다.
19+
3. 구조가 쉬운 프로젝트입니다.</br></br>
20+
21+
## 프로젝트에 구현된 기능 목록
22+
- 회원 가입
23+
- 로그인 (토큰 발급)
24+
- 토큰 재발급
25+
- 더미 게시글 조회 (토큰 인증)</br></br>
26+
27+
---
28+
29+
</br>
30+
31+
### 🚀 기여하는 방법
32+
수정하신 부분에 대한 명확한 설명과 함께 main 브랜치에 pull request를 올려주세요. </br>
33+
34+
✅ 영문법 개선도 환영합니다. </br>
35+
✅ 새로운 기능을 추가하는 것도 좋습니다. </br>
36+
-> 그러나 항상 코드를 간단하게 유지해주세요. 복잡한 코드보다는 보기 편한 코드를 지향합니다. </br>
37+
✅ 가독성 향상을 위한 코드 피드백도 항상 감사드립니다. </br>
38+
✅ 깃허브 스타를 눌러주시면 감사하겠습니다.⭐ </br>
39+
</br>
40+
### 🙋질문
41+
만약 질문이 있으시다면, 깃허브 이슈 탭에 'wanted' 또는 'question' 태그를 붙여서 올려주세요. :-)

Diff for: README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,13 @@ This project develops an authentication service using the following technologies
1515

1616
### Why Is This Project Important?
1717
1. This can help those who are new to the project and need a guide to the Nest.
18-
2. You know the basic usage of mongoose, even aggravate.
19-
3. You will also be able to understand the fundamentals related to authentication.
20-
4. It is a project with an easy structure.
18+
2. You will also be able to understand the fundamentals related to authentication.
19+
3. It is a project with an easy structure.
2120

2221
### How to Contribute
2322
Please submit a pull request to the main branch with a clear description of your changes.</br>
2423
✅ Improving English grammar is also welcome.</br>
25-
✅ Adding new features is encourage
24+
✅ Adding new features is encouraged.
2625
—> just keep the code straightforward.</br>
2726
✅ Feedback for better readability is always appreciated.</br>
2827
✅ If you press the star⭐️, it gives you a lot of strength.

0 commit comments

Comments
 (0)