typescript-express-starter 6.0.0 โ†’ 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/README.kr.md +133 -52
  2. package/README.md +134 -54
  3. package/bin/cli.js +4 -3
  4. package/lib/default/.swcrc +41 -0
  5. package/lib/default/Dockerfile +1 -1
  6. package/lib/default/ecosystem.config.js +40 -24
  7. package/lib/default/nodemon.json +2 -2
  8. package/lib/default/package.json +15 -8
  9. package/lib/default/src/app.ts +1 -2
  10. package/lib/default/src/http/auth.http +12 -15
  11. package/lib/default/src/http/users.http +12 -16
  12. package/lib/default/src/index.ts +1 -0
  13. package/lib/default/src/middlewares/auth.middleware.ts +3 -3
  14. package/lib/default/src/models/users.model.ts +5 -5
  15. package/lib/default/src/server.ts +1 -2
  16. package/lib/default/src/services/auth.service.ts +5 -5
  17. package/lib/default/src/services/users.service.ts +3 -3
  18. package/lib/default/src/tests/auth.test.ts +4 -4
  19. package/lib/default/src/tests/users.test.ts +4 -4
  20. package/lib/default/src/utils/logger.ts +5 -5
  21. package/lib/default/src/utils/util.ts +1 -1
  22. package/lib/default/tsconfig.json +2 -2
  23. package/lib/knex/.swcrc +39 -0
  24. package/lib/knex/Dockerfile +1 -1
  25. package/lib/knex/ecosystem.config.js +57 -43
  26. package/lib/knex/knexfile.ts +6 -6
  27. package/lib/knex/nodemon.json +2 -2
  28. package/lib/knex/package.json +14 -8
  29. package/lib/knex/src/app.ts +2 -3
  30. package/lib/knex/src/databases/index.ts +6 -6
  31. package/lib/knex/src/http/auth.http +12 -15
  32. package/lib/knex/src/http/users.http +12 -16
  33. package/lib/knex/src/index.ts +1 -0
  34. package/lib/knex/src/middlewares/auth.middleware.ts +4 -4
  35. package/lib/knex/src/server.ts +1 -2
  36. package/lib/knex/src/services/auth.service.ts +5 -5
  37. package/lib/knex/src/services/users.service.ts +3 -3
  38. package/lib/knex/src/tests/auth.test.ts +2 -2
  39. package/lib/knex/src/tests/index.test.ts +1 -1
  40. package/lib/knex/src/tests/users.test.ts +2 -2
  41. package/lib/knex/src/utils/logger.ts +5 -5
  42. package/lib/knex/src/utils/util.ts +1 -1
  43. package/lib/knex/tsconfig.json +2 -2
  44. package/lib/mongoose/.swcrc +39 -0
  45. package/lib/mongoose/Dockerfile +1 -1
  46. package/lib/mongoose/docker-compose.yml +0 -4
  47. package/lib/mongoose/ecosystem.config.js +42 -27
  48. package/lib/mongoose/nodemon.json +2 -2
  49. package/lib/mongoose/package.json +15 -8
  50. package/lib/mongoose/src/app.ts +2 -3
  51. package/lib/mongoose/src/configs/development.json +1 -1
  52. package/lib/mongoose/src/configs/production.json +1 -1
  53. package/lib/mongoose/src/configs/test.json +1 -1
  54. package/lib/mongoose/src/http/auth.http +32 -0
  55. package/lib/mongoose/src/http/users.http +34 -0
  56. package/lib/mongoose/src/index.ts +1 -0
  57. package/lib/mongoose/src/middlewares/auth.middleware.ts +3 -3
  58. package/lib/mongoose/src/server.ts +1 -2
  59. package/lib/mongoose/src/services/auth.service.ts +5 -5
  60. package/lib/mongoose/src/services/users.service.ts +3 -3
  61. package/lib/mongoose/src/utils/logger.ts +5 -5
  62. package/lib/mongoose/src/utils/util.ts +1 -1
  63. package/lib/mongoose/tsconfig.json +2 -2
  64. package/lib/prisma/.env +1 -1
  65. package/lib/prisma/.swcrc +37 -0
  66. package/lib/prisma/Dockerfile +1 -1
  67. package/lib/prisma/docker-compose.yml +1 -6
  68. package/lib/prisma/ecosystem.config.js +40 -24
  69. package/lib/prisma/nodemon.json +2 -2
  70. package/lib/prisma/package.json +17 -10
  71. package/lib/prisma/src/app.ts +2 -3
  72. package/lib/prisma/src/http/auth.http +12 -15
  73. package/lib/prisma/src/http/users.http +12 -16
  74. package/lib/prisma/src/index.ts +1 -0
  75. package/lib/prisma/src/middlewares/auth.middleware.ts +4 -4
  76. package/lib/prisma/src/server.ts +1 -2
  77. package/lib/prisma/src/services/auth.service.ts +5 -5
  78. package/lib/prisma/src/services/users.service.ts +3 -3
  79. package/lib/prisma/src/utils/logger.ts +5 -5
  80. package/lib/prisma/src/utils/util.ts +1 -1
  81. package/lib/prisma/tsconfig.json +2 -2
  82. package/lib/routing-controllers/.swcrc +37 -0
  83. package/lib/routing-controllers/Dockerfile +1 -1
  84. package/lib/routing-controllers/ecosystem.config.js +40 -24
  85. package/lib/routing-controllers/nodemon.json +2 -2
  86. package/lib/routing-controllers/package.json +18 -11
  87. package/lib/routing-controllers/src/app.ts +33 -6
  88. package/lib/routing-controllers/src/http/auth.http +12 -15
  89. package/lib/routing-controllers/src/http/users.http +12 -16
  90. package/lib/routing-controllers/src/index.ts +1 -0
  91. package/lib/routing-controllers/src/middlewares/auth.middleware.ts +3 -3
  92. package/lib/routing-controllers/src/middlewares/validation.middleware.ts +10 -2
  93. package/lib/routing-controllers/src/models/users.model.ts +5 -5
  94. package/lib/routing-controllers/src/server.ts +1 -3
  95. package/lib/routing-controllers/src/services/auth.service.ts +5 -5
  96. package/lib/routing-controllers/src/services/users.service.ts +3 -3
  97. package/lib/routing-controllers/src/utils/logger.ts +5 -5
  98. package/lib/routing-controllers/src/utils/util.ts +1 -1
  99. package/lib/routing-controllers/tsconfig.json +2 -2
  100. package/lib/sequelize/.swcrc +39 -0
  101. package/lib/sequelize/Dockerfile +1 -1
  102. package/lib/sequelize/docker-compose.yml +1 -6
  103. package/lib/sequelize/ecosystem.config.js +42 -27
  104. package/lib/sequelize/nodemon.json +2 -2
  105. package/lib/sequelize/package.json +15 -8
  106. package/lib/sequelize/src/app.ts +1 -2
  107. package/lib/sequelize/src/configs/development.json +2 -2
  108. package/lib/sequelize/src/configs/production.json +1 -1
  109. package/lib/sequelize/src/configs/test.json +1 -1
  110. package/lib/sequelize/src/http/auth.http +32 -0
  111. package/lib/sequelize/src/http/users.http +34 -0
  112. package/lib/sequelize/src/index.ts +1 -0
  113. package/lib/sequelize/src/middlewares/auth.middleware.ts +4 -4
  114. package/lib/sequelize/src/server.ts +1 -2
  115. package/lib/sequelize/src/services/auth.service.ts +5 -5
  116. package/lib/sequelize/src/services/users.service.ts +3 -3
  117. package/lib/sequelize/src/utils/logger.ts +5 -5
  118. package/lib/sequelize/src/utils/util.ts +1 -1
  119. package/lib/sequelize/tsconfig.json +2 -2
  120. package/lib/starter.js +8 -12
  121. package/lib/typeorm/.swcrc +39 -0
  122. package/lib/typeorm/Dockerfile +1 -1
  123. package/lib/typeorm/docker-compose.yml +1 -1
  124. package/lib/typeorm/ecosystem.config.js +42 -27
  125. package/lib/typeorm/nodemon.json +2 -2
  126. package/lib/typeorm/package.json +15 -8
  127. package/lib/typeorm/src/app.ts +1 -2
  128. package/lib/typeorm/src/configs/development.json +1 -1
  129. package/lib/typeorm/src/configs/production.json +1 -1
  130. package/lib/typeorm/src/configs/test.json +1 -1
  131. package/lib/typeorm/src/databases/index.ts +5 -5
  132. package/lib/typeorm/src/{entity โ†’ entities}/users.entity.ts +3 -3
  133. package/lib/typeorm/src/http/auth.http +12 -15
  134. package/lib/typeorm/src/http/users.http +12 -16
  135. package/lib/typeorm/src/index.ts +1 -0
  136. package/lib/typeorm/src/middlewares/auth.middleware.ts +5 -9
  137. package/lib/typeorm/src/server.ts +1 -2
  138. package/lib/typeorm/src/services/auth.service.ts +13 -17
  139. package/lib/typeorm/src/services/users.service.ts +16 -22
  140. package/lib/typeorm/src/utils/logger.ts +5 -5
  141. package/lib/typeorm/src/utils/util.ts +1 -1
  142. package/lib/typeorm/tsconfig.json +3 -3
  143. package/package.json +12 -4
package/README.kr.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <h1 align="center">
2
2
  <br>
3
- <img src='https://github.com/ljlm0402/typescript-express-starter/raw/images/logo.jpg' border='0' alt='logo' />
3
+ <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/logo.jpg" alt="ํ”„๋กœ์ ํŠธ ๋กœ๊ณ " />
4
4
  <br>
5
5
  <br>
6
6
  ํƒ€์ž…์Šคํฌ๋ฆฝํŠธ ์ต์Šคํ”„๋ ˆ์Šค ์Šคํƒ€ํ„ฐ
@@ -10,26 +10,55 @@
10
10
  <h4 align="center">๐Ÿš€ ํƒ€์ž…์Šคํฌ๋ฆฝํŠธ ๊ธฐ๋ฐ˜์˜ ์ต์Šคํ”„๋ ˆ์Šค ๋ณด์ผ๋Ÿฌ ํ”Œ๋ ˆ์ดํŠธ ์Šคํƒ€ํ„ฐ ํŒจํ‚ค์ง€</h4>
11
11
 
12
12
  <p align="center">
13
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/npm/v/typescript-express-starter.svg" alt="npm ๋ฒ„์ „" /></a>
14
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/npm/l/typescript-express-starter.svg" alt="ํŒจํ‚ค์ง€ ๋ผ์ด์„ ์Šค" /></a>
15
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/github/v/release/ljlm0402/typescript-express-starter" alt="๋ฆด๋ฆฌ์ฆˆ ๋ฒ„์ „" /></a>
16
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/npm/dm/typescript-express-starter.svg" alt="npm ๋‹ค์šด๋กœ๋“œ ์ˆ˜" /></a>
13
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
14
+ <img src="https://img.shields.io/npm/v/typescript-express-starter.svg" alt="npm ๋ฒ„์ „" />
15
+ </a>
16
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
17
+ <img src="https://img.shields.io/github/v/release/ljlm0402/typescript-express-starter" alt="npm ๋ฆด๋ฆฌ์ฆˆ ๋ฒ„์ „" />
18
+ </a>
19
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
20
+ <img src="https://img.shields.io/npm/l/typescript-express-starter.svg" alt="npm ํŒจํ‚ค์ง€ ๋ผ์ด์„ ์Šค" />
21
+ </a>
22
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
23
+ <img src="https://img.shields.io/npm/dm/typescript-express-starter.svg" alt="npm ๋‹ค์šด๋กœ๋“œ ์ˆ˜" />
24
+ </a>
17
25
  </p>
18
26
 
19
- <br />
20
-
21
27
  <p align="center">
22
- <a href="https://github.com/ljlm0402/typescript-express-starter/blob/master/README.md">๐Ÿ‡บ๐Ÿ‡ธ</a>
23
- <a href="https://github.com/ljlm0402/typescript-express-starter/blob/master/README.kr.md">๐Ÿ‡ฐ๐Ÿ‡ท</a>
28
+ <a href="https://github.com/ljlm0402/typescript-express-starter/stargazers" target="_blank">
29
+ <img src="https://img.shields.io/github/stars/ljlm0402/typescript-express-starter" alt="github ์Šคํƒ€"/>
30
+ </a>
31
+ <a href="https://github.com/ljlm0402/typescript-express-starter/network/members" target="_blank">
32
+ <img src="https://img.shields.io/github/forks/ljlm0402/typescript-express-starter" alt="github ํฌํฌ" />
33
+ </a>
34
+ <a href="https://github.com/ljlm0402/typescript-express-starter/stargazers" target="_blank">
35
+ <img src="https://img.shields.io/github/contributors/ljlm0402/typescript-express-starter" alt="github ์ปจํŠธ๋ฆฌ๋ทฐํ„ฐ" />
36
+ </a>
37
+ <a href="https://github.com/ljlm0402/typescript-express-starter/issues" target="_blank">
38
+ <img src="https://img.shields.io/github/issues/ljlm0402/typescript-express-starter" alt="github ์ด์Šˆ" />
39
+ </a>
24
40
  </p>
25
41
 
26
42
  <br />
27
43
 
28
- ## ๐Ÿค” Express๋Š” ๋ฌด์—‡์ธ๊ฐ€์š” ?
44
+ ## ๋ฒˆ์—ญ๋ณธ - ์ž์‹ ์ด ์›ํ•˜๋Š” ์–ธ์–ด๋กœ ์ฝ์œผ์„ธ์š”
29
45
 
30
- Node.js๋ฅผ ์œ„ํ•œ ๋น ๋ฅด๊ณ  ๊ฐœ๋ฐฉ์ ์ธ ๊ฐ„๊ฒฐํ•œ ์›น ํ”„๋ ˆ์ž„์›Œํฌ์ž…๋‹ˆ๋‹ค.
46
+ - [๐Ÿ‡บ๐Ÿ‡ธ ์˜์–ด](https://github.com/ljlm0402/typescript-express-starter/blob/master/README.md)
47
+ - [๐Ÿ‡ฐ๐Ÿ‡ท ํ•œ๊ตญ์–ด](https://github.com/ljlm0402/typescript-express-starter/blob/master/README.kr.md)
48
+
49
+ > ๋ฒˆ์—ญ์„ ๋„์™€์ฃผ์‹ค ๋ถ„์€ ์ด์Šˆ ๋‚จ๊ฒจ์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ๐Ÿ’œ
50
+
51
+ <br />
52
+
53
+ ## ์›น ์‚ฌ์ดํŠธ - ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ ๋ฐ ํ™๋ณด
54
+
55
+ - [๐Ÿ’๐Ÿปโ€โ™‚๏ธ Dylan Iqbal :: A TypeScript Express Starter App](https://bit.ly/3rrZFZ9)
31
56
 
32
- ## ๐Ÿ˜Ž ๋‚˜์˜ ์˜คํ”ˆ์†Œ์Šค๋ฅผ ์†Œ๊ฐœํ•ฉ๋‹ˆ๋‹ค.
57
+ > ์›น ์‚ฌ์ดํŠธ ๋ฐ ๋ธ”๋กœ๊ทธ์— ์†Œ๊ฐœ๋ฅผ ์›ํ•˜์‹œ๋Š” ๋ถ„์€ ์ด์Šˆ ๋‚จ๊ฒจ์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ๐Ÿ’™
58
+
59
+ <br />
60
+
61
+ ## ๐Ÿ˜Ž ํ”„๋กœ์ ํŠธ๋ฅผ ์†Œ๊ฐœํ•ฉ๋‹ˆ๋‹ค.
33
62
 
34
63
  Express๋Š” ์œ ํ˜• ์ •์˜์— ์ทจ์•ฝํ•œ JavaScript๋กœ ๊ตฌ์„ฑ ๋˜์–ด์žˆ์Šต๋‹ˆ๋‹ค.
35
64
 
@@ -39,6 +68,10 @@ Express๋Š” ์œ ํ˜• ์ •์˜์— ์ทจ์•ฝํ•œ JavaScript๋กœ ๊ตฌ์„ฑ ๋˜์–ด์žˆ์Šต๋‹ˆ๋‹ค.
39
68
 
40
69
  > ์ฐธ๊ณ  : [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript)
41
70
 
71
+ ### ๐Ÿค” Express๋Š” ๋ฌด์—‡์ธ๊ฐ€์š” ?
72
+
73
+ Node.js๋ฅผ ์œ„ํ•œ ๋น ๋ฅด๊ณ  ๊ฐœ๋ฐฉ์ ์ธ ๊ฐ„๊ฒฐํ•œ ์›น ํ”„๋ ˆ์ž„์›Œํฌ์ž…๋‹ˆ๋‹ค.
74
+
42
75
  ## ๐Ÿš€ ์‹œ์ž‘ํ•˜๊ธฐ
43
76
 
44
77
  ### npm ์ „์—ญ ์„ค์น˜
@@ -57,7 +90,7 @@ $ npx typescript-express-starter "project name"
57
90
 
58
91
  ### ์›ํ•˜์‹œ๋Š” ํ…œํ”Œ๋ฆฟ์„ ์„ ํƒ
59
92
 
60
- <img src='https://github.com/ljlm0402/typescript-express-starter/raw/images/cli.gif' border='0' alt='cli' />
93
+ <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/cli.gif" alt="์˜ˆ์‹œ" />
61
94
 
62
95
  ์„ค์น˜๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด Script ๋ช…๋ น์–ด๋ฅผ ํ†ตํ•ด ํ”„๋กœ์ ํŠธ๋ฅผ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.
63
96
 
@@ -84,25 +117,35 @@ $ npx typescript-express-starter "project name"
84
117
 
85
118
  ## ๐Ÿ’Ž ํ”„๋กœ์ ํŠธ ๊ธฐ๋Šฅ
86
119
 
87
- ![](https://img.shields.io/badge/-Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=fff)
88
- ![](https://img.shields.io/badge/-NPM-CB3837?style=for-the-badge&logo=NPM&logoColor=fff)
89
- ![](https://img.shields.io/badge/-TypeScript-007ACC?style=for-the-badge&logo=TypeScript&logoColor=fff)
90
- ![](https://img.shields.io/badge/-Express-F8F8F5?style=for-the-badge)
91
- ![](https://img.shields.io/badge/-Nodemon-76D04B?style=for-the-badge&logo=Nodemon&logoColor=fff)
92
- ![](https://img.shields.io/badge/-ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=fff)
93
- ![](https://img.shields.io/badge/-Prettier-F7B93E?style=for-the-badge&logo=Prettier&logoColor=000)
94
- ![](https://img.shields.io/badge/-Jest-C21325?style=for-the-badge&logo=Jest&logoColor=fff)
95
- ![](https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=000)
96
- ![](https://img.shields.io/badge/-Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=fff)
97
- ![](https://img.shields.io/badge/-NGINX-269539?style=for-the-badge&logo=NGINX&logoColor=fff)
98
- ![](https://img.shields.io/badge/-MySQL-4479A1?style=for-the-badge&logo=MySQL&logoColor=fff)
99
- ![](https://img.shields.io/badge/-MariaDB-003545?style=for-the-badge&logo=MariaDB&logoColor=fff)
100
- ![](https://img.shields.io/badge/-PostgreSQL-336791?style=for-the-badge&logo=PostgreSQL&logoColor=fff)
101
- ![](https://img.shields.io/badge/-MongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=fff)
120
+ - Application
121
+
122
+ - ![](https://img.shields.io/badge/-TypeScript-007ACC?style=for-the-badge&logo=TypeScript&logoColor=fff)
123
+ ![](https://img.shields.io/badge/-Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=fff)
124
+ ![](https://img.shields.io/badge/-NPM-CB3837?style=for-the-badge&logo=NPM&logoColor=fff)
125
+ ![](https://img.shields.io/badge/-NGINX-269539?style=for-the-badge&logo=NGINX&logoColor=fff)
126
+
127
+ - DevOps
128
+
129
+ - ![](https://img.shields.io/badge/-Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=fff)
130
+ ![](https://img.shields.io/badge/-Nodemon-76D04B?style=for-the-badge&logo=Nodemon&logoColor=fff)
131
+ ![](https://img.shields.io/badge/-PM2-2B037A?style=for-the-badge&logo=PM2&logoColor=fff)
132
+ ![](https://img.shields.io/badge/-ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=fff)
133
+ ![](https://img.shields.io/badge/-Prettier-F7B93E?style=for-the-badge&logo=Prettier&logoColor=000)
134
+ ![](https://img.shields.io/badge/-Jest-C21325?style=for-the-badge&logo=Jest&logoColor=fff)
135
+
136
+ - Utilities
137
+
138
+ - ![](https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=000)
139
+
140
+ - Database
141
+ - ![](https://img.shields.io/badge/-MySQL-4479A1?style=for-the-badge&logo=MySQL&logoColor=fff)
142
+ ![](https://img.shields.io/badge/-MariaDB-003545?style=for-the-badge&logo=MariaDB&logoColor=fff)
143
+ ![](https://img.shields.io/badge/-PostgreSQL-336791?style=for-the-badge&logo=PostgreSQL&logoColor=fff)
144
+ ![](https://img.shields.io/badge/-MongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=fff)
102
145
 
103
146
  > [Simple Icons](https://simpleicons.org/)
104
147
 
105
- ### ๐Ÿณ ๋„์ปค
148
+ ### ๐Ÿณ ๋„์ปค :: ์ปจํ…Œ์ด๋„ˆ ํ”Œ๋žซํผ
106
149
 
107
150
  [๋„์ปค](https://docs.docker.com/)๋ž€, ์ปจํ…Œ์ด๋„ˆ ๊ธฐ๋ฐ˜์˜ ์˜คํ”ˆ์†Œ์Šค ๊ฐ€์ƒํ™” ํ”Œ๋žซํผ์ด๋‹ค.
108
151
 
@@ -113,7 +156,7 @@ $ npx typescript-express-starter "project name"
113
156
 
114
157
  ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด `docker-compose.yml`๊ณผ `Dockerfile`๋ฅผ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
115
158
 
116
- ### โ™ป๏ธ ์—”์ง„์—‘์Šค - ๋ฆฌ๋ฒ„์Šค ํ”„๋ก์‹œ
159
+ ### โ™ป๏ธ ์—”์ง„์—‘์Šค :: ์›น ์„œ๋ฒ„
117
160
 
118
161
  [์—”์ง„์—‘์Šค](https://www.nginx.com/) ์—ญ๋ฐฉํ–ฅ ํ”„๋ก์‹œ,๋กœ๋“œ ๋ฐธ๋Ÿฐ์„œ, ๋ฉ”์ผ ํ”„๋ก์‹œ ๋ฐ HTTP ์บ์‹œ๋กœ๋„ ์‚ฌ์šฉํ•  ์ˆ˜์žˆ๋Š” ์›น ์„œ๋ฒ„์ž…๋‹ˆ๋‹ค.
119
162
 
@@ -123,9 +166,7 @@ $ npx typescript-express-starter "project name"
123
166
 
124
167
  ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด `nginx.conf` ํŒŒ์ผ์„ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
125
168
 
126
- ### โœจ ESLint, Prettier - ์ฝ”๋“œ ํฌ๋งทํ„ฐ
127
-
128
- 2019๋…„, TSLint ์ง€์›์ด ์ข…๋ฃŒ ๋˜์–ด ESLint๋ฅผ ์ ์šฉํ•˜์˜€์Šต๋‹ˆ๋‹ค.
169
+ ### โœจ ESLint, Prettier :: ์ •์  ์ฝ”๋“œ ๋ถ„์„ ๋ฐ ์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€ํ™˜
129
170
 
130
171
  [ESLint](https://eslint.org/)๋Š” JavaScript ์ฝ”๋“œ์—์„œ ๋ฐœ๊ฒฌ ๋œ ๋ฌธ์ œ ํŒจํ„ด์„ ์‹๋ณ„ํ•˜๊ธฐ์œ„ํ•œ ์ •์  ์ฝ”๋“œ ๋ถ„์„ ๋„๊ตฌ์ž…๋‹ˆ๋‹ค.
131
172
 
@@ -143,11 +184,13 @@ $ npx typescript-express-starter "project name"
143
184
 
144
185
  5. Prettier - Code formatter ์ ์šฉํ•ฉ๋‹ˆ๋‹ค.
145
186
 
146
- <img src='https://github.com/ljlm0402/typescript-express-starter/raw/images/formatter.png' border='0' alt='formatter' />
187
+ <img src="https://user-images.githubusercontent.com/42952358/126604937-4ef50b61-b7e4-4635-b3c9-3c94dd6b06fa.png" alt="Formatter ์„ค์ •" />
188
+
189
+ > 2019๋…„, TSLint ์ง€์›์ด ์ข…๋ฃŒ ๋˜์–ด ESLint๋ฅผ ์ ์šฉํ•˜์˜€์Šต๋‹ˆ๋‹ค.
147
190
 
148
- ### ๐Ÿ“— Swagger - API ๋ฌธ์„œํ™”
191
+ ### ๐Ÿ“— ์Šค์›จ๊ฑฐ :: API ๋ฌธ์„œํ™”
149
192
 
150
- [์Šค์›จ๊ฑฐ](https://swagger.io/) ๊ฐœ๋ฐœ์ž๊ฐ€ REST ์›น ์„œ๋น„์Šค๋ฅผ ์„ค๊ณ„, ๋นŒ๋“œ, ๋ฌธ์„œํ™”, ์†Œ๋น„ํ•˜๋Š” ์ผ์„ ๋„์™€์ฃผ๋Š” ๋Œ€ํ˜• ๋„๊ตฌ ์ƒํƒœ๊ณ„์˜ ์ง€์›์„ ๋ฐ›๋Š” ์˜คํ”ˆ ์†Œ์Šค ์†Œํ”„ํŠธ์›จ์–ด ํ”„๋ ˆ์ž„์›Œํฌ์ด๋‹ค.
193
+ [์Šค์›จ๊ฑฐ](https://swagger.io/)๋Š” ๊ฐœ๋ฐœ์ž๊ฐ€ REST ์›น ์„œ๋น„์Šค๋ฅผ ์„ค๊ณ„, ๋นŒ๋“œ, ๋ฌธ์„œํ™”, ์†Œ๋น„ํ•˜๋Š” ์ผ์„ ๋„์™€์ฃผ๋Š” ๋Œ€ํ˜• ๋„๊ตฌ ์ƒํƒœ๊ณ„์˜ ์ง€์›์„ ๋ฐ›๋Š” ์˜คํ”ˆ ์†Œ์Šค ์†Œํ”„ํŠธ์›จ์–ด ํ”„๋ ˆ์ž„์›Œํฌ์ด๋‹ค.
151
194
 
152
195
  API๋ฅผ ๋Œ€๊ทœ๋ชจ๋กœ ์„ค๊ณ„ํ•˜๊ณ  ๋ฌธ์„œํ™”ํ•˜๋Š” ๋ฐ ์šฉ์ดํ•˜๊ฒŒ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
153
196
 
@@ -155,13 +198,33 @@ API๋ฅผ ๋Œ€๊ทœ๋ชจ๋กœ ์„ค๊ณ„ํ•˜๊ณ  ๋ฌธ์„œํ™”ํ•˜๋Š” ๋ฐ ์šฉ์ดํ•˜๊ฒŒ ์‚ฌ์šฉํ•ฉ๋‹ˆ
155
198
 
156
199
  ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด `swagger.yaml` ํŒŒ์ผ์„ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
157
200
 
158
- ### ๐ŸŒ REST Client(VSCode Extension) - HTTP Client ๋„๊ตฌ
201
+ ### ๐ŸŒ REST Client :: HTTP Client ๋„๊ตฌ
159
202
 
160
203
  REST ํด๋ผ์ด์–ธํŠธ๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด HTTP ์š”์ฒญ์„ ๋ณด๋‚ด๊ณ  Visual Studio Code์—์„œ ์ง์ ‘ ์‘๋‹ต์„ ๋ณผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
161
204
 
162
205
  VSCode Extension์—์„œ [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค.
163
206
 
164
- ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด http ํด๋” ์•ˆ์— `*.http` ํŒŒ์ผ์„ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
207
+ ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด src/http ํด๋” ์•ˆ์— `*.http` ํŒŒ์ผ์„ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
208
+
209
+ ### ๐Ÿ”ฎ PM2 :: ์›น ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ์šด์˜ ๋ฐ ํ”„๋กœ์„ธ์Šค ๊ด€๋ฆฌ์ž
210
+
211
+ [PM2](https://pm2.keymetrics.io/)๋ž€, ์„œ๋ฒ„์—์„œ ์›น ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ์šด์˜ํ•  ๋•Œ ๋ณดํ†ต ๋ฐ๋ชฌ์œผ๋กœ ์„œ๋ฒ„๋ฅผ ๋„์›Œ์•ผ ํ•˜๊ณ  Node.js์˜ ๊ฒฝ์šฐ ์„œ๋ฒ„๊ฐ€ ํฌ๋ž˜์‹œ๋‚˜๋ฉด ์žฌ์‹œ์ž‘์„ ํ•˜๊ธฐ ์œ„ํ•ด์„œ ์›Œ์น˜๋…(watchdog) ๋ฅ˜์˜ ํ”„๋กœ์„ธ์Šค ๊ด€๋ฆฌ์ž์ด๋‹ค.
212
+
213
+ - ํ”„๋กœ๋•์…˜ ๋ชจ๋“œ :: `npm run deploy:prod` ๋˜๋Š” `pm2 start ecosystem.config.js --only prod`
214
+ - ๊ฐœ๋ฐœ ๋ชจ๋“œ :: `npm run deploy:dev` ๋˜๋Š” `pm2 start ecosystem.config.js --only dev`
215
+
216
+ ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด `ecosystem.config.js` ํŒŒ์ผ์„ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
217
+
218
+ ### ๐ŸŽ SWC :: ๊ฐ•ํ•˜๊ณ  ๋น ๋ฅธ ์ž๋ฐ”์Šคํฌ๋ฆฝํŠธ / ํƒ€์ž…์Šคํฌ๋ฆฝํŠธ ์ปดํŒŒ์ผ๋Ÿฌ
219
+
220
+ [SWC](https://swc.rs/)๋Š” ์ฐจ์„ธ๋Œ€ ๊ณ ์† ๊ฐœ๋ฐœ์ž ๋„๊ตฌ๋ฅผ ์œ„ํ•œ ํ™•์žฅ ๊ฐ€๋Šฅํ•œ Rust ๊ธฐ๋ฐ˜ ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค.
221
+
222
+ `SWC๋Š” ๋‹จ์ผ ์Šค๋ ˆ๋“œ์—์„œ Babel๋ณด๋‹ค 20๋ฐฐ, 4๊ฐœ ์ฝ”์–ด์—์„œ 70๋ฐฐ ๋น ๋ฆ…๋‹ˆ๋‹ค.`
223
+
224
+ - swc ๋นŒ๋“œ :: `npm run build`
225
+ - tsc ๋นŒ๋“œ :: `npm run build:tsc`
226
+
227
+ ์ˆ˜์ •์„ ์›ํ•˜์‹œ๋ฉด `.swcrc` ํŒŒ์ผ์„ ์ˆ˜์ •ํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
165
228
 
166
229
  ## ๐Ÿ—‚ ์ฝ”๋“œ ๊ตฌ์กฐ (default)
167
230
 
@@ -225,6 +288,7 @@ VSCode Extension์—์„œ [REST Client](https://marketplace.visualstudio.com/items?
225
288
  โ”‚ โ”‚ โ””โ”€โ”€ vaildateEnv.ts
226
289
  โ”‚ โ”‚
227
290
  โ”‚ โ”œโ”€โ”€ app.ts
291
+ โ”‚ โ”œโ”€โ”€ index.ts
228
292
  โ”‚ โ””โ”€โ”€ server.ts
229
293
  โ”‚
230
294
  โ”œโ”€โ”€ .dockerignore
@@ -236,6 +300,7 @@ VSCode Extension์—์„œ [REST Client](https://marketplace.visualstudio.com/items?
236
300
  โ”œโ”€โ”€ .huskyrc
237
301
  โ”œโ”€โ”€ .lintstagedrc.json
238
302
  โ”œโ”€โ”€ .prettierrc
303
+ โ”œโ”€โ”€ .swcrc
239
304
  โ”œโ”€โ”€ docker-compose.yml
240
305
  โ”œโ”€โ”€ Dockerfile
241
306
  โ”œโ”€โ”€ ecosystem.config.js
@@ -249,25 +314,17 @@ VSCode Extension์—์„œ [REST Client](https://marketplace.visualstudio.com/items?
249
314
  โ””โ”€โ”€ tsconfig.json
250
315
  ```
251
316
 
252
- ## ๐Ÿ“ฌ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์ •์˜
317
+ ## โญ๏ธ ์ฃผ์‹ ๋ถ„๋“ค
253
318
 
254
- | ์–ธ์ œ | ๋ฉ”์‹œ์ง€ |
255
- | :----------------- | :-------------------- |
256
- | ๊ธฐ๋Šฅ ์ถ”๊ฐ€ | โœจ ๊ธฐ๋Šฅ ์ถ”๊ฐ€ |
257
- | ๋ฒ„๊ทธ ์ˆ˜์ • | ๐Ÿž ๋ฒ„๊ทธ ์ˆ˜์ • |
258
- | ์ฝ”๋“œ ๊ฐœ์„  | ๐Ÿ›  ์ฝ”๋“œ ๊ฐœ์„  |
259
- | ํŒจํ‚ค์ง€ ์„ค์น˜ | ๐Ÿ“ฆ ํŒจํ‚ค์ง€ ์„ค์น˜ |
260
- | ๋ฌธ์„œ ์ˆ˜์ • | ๐Ÿ“š ๋ฌธ์„œ ์ˆ˜์ • |
261
- | ๋ฒ„์ „ ์—…๋ฐ์ดํŠธ | ๐ŸŒผ ๋ฒ„์ „ ์—…๋ฐ์ดํŠธ |
262
- | ์ƒˆ๋กœ์šด ํ…œํ”Œ๋ฆฟ ์ถ”๊ฐ€ | ๐ŸŽ‰ ์ƒˆ๋กœ์šด ํ…œํ”Œ๋ฆฟ ์ถ”๊ฐ€ |
319
+ [![Stargazers repo roster for @ljlm0402/typescript-express-starter](https://reporoster.com/stars/ljlm0402/typescript-express-starter)](https://github.com/ljlm0402/typescript-express-starter/stargazers)
263
320
 
264
- ## ๐Ÿ’ณ ๋ผ์ด์„ผ์Šค
321
+ ## ๐Ÿด ํ•ด์ฃผ์‹ ๋ถ„๋“ค
265
322
 
266
- [MIT](LICENSE)
323
+ [![Forkers repo roster for @ljlm0402/typescript-express-starter](https://reporoster.com/forks/ljlm0402/typescript-express-starter)](https://github.com/ljlm0402/typescript-express-starter/network/members)
267
324
 
268
325
  ## ๐Ÿค ๋„์›€์„ ์ฃผ์‹ ๋ถ„๋“ค
269
326
 
270
- <img src="https://contributors-img.web.app/image?repo=ljlm0402/typescript-express-starter" alt="Contributors">
327
+ <img src="https://contributors-img.web.app/image?repo=ljlm0402/typescript-express-starter" alt="๊ธฐ์—ฌ์ž">
271
328
 
272
329
  - Jeongwon Kim [https://github.com/swtpumpkin](https://github.com/swtpumpkin)
273
330
 
@@ -301,8 +358,32 @@ VSCode Extension์—์„œ [REST Client](https://marketplace.visualstudio.com/items?
301
358
 
302
359
  - michael r [https://github.com/alanmynah](https://github.com/alanmynah)
303
360
 
361
+ - Benjamin [https://github.com/benjaminudoh10](https://github.com/benjaminudoh10)
362
+
363
+ - Amrik Singh [https://github.com/AmrikSD](https://github.com/AmrikSD)
364
+
365
+ - oricc [https://github.com/oricc](https://github.com/oricc)
366
+
367
+ ## ๐Ÿ’ณ ๋ผ์ด์„ผ์Šค
368
+
369
+ [MIT](LICENSE)
370
+
371
+ ## ๐Ÿ“ฌ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์ •์˜
372
+
373
+ | ์–ธ์ œ | ๋ฉ”์‹œ์ง€ |
374
+ | :----------------- | :-------------------- |
375
+ | ๊ธฐ๋Šฅ ์ถ”๊ฐ€ | โœจ ๊ธฐ๋Šฅ ์ถ”๊ฐ€ |
376
+ | ๋ฒ„๊ทธ ์ˆ˜์ • | ๐Ÿž ๋ฒ„๊ทธ ์ˆ˜์ • |
377
+ | ์ฝ”๋“œ ๊ฐœ์„  | ๐Ÿ›  ์ฝ”๋“œ ๊ฐœ์„  |
378
+ | ํŒจํ‚ค์ง€ ์„ค์น˜ | ๐Ÿ“ฆ ํŒจํ‚ค์ง€ ์„ค์น˜ |
379
+ | ๋ฌธ์„œ ์ˆ˜์ • | ๐Ÿ“š ๋ฌธ์„œ ์ˆ˜์ • |
380
+ | ๋ฒ„์ „ ์—…๋ฐ์ดํŠธ | ๐ŸŒผ ๋ฒ„์ „ ์—…๋ฐ์ดํŠธ |
381
+ | ์ƒˆ๋กœ์šด ํ…œํ”Œ๋ฆฟ ์ถ”๊ฐ€ | ๐ŸŽ‰ ์ƒˆ๋กœ์šด ํ…œํ”Œ๋ฆฟ ์ถ”๊ฐ€ |
382
+
304
383
  ## ๐Ÿ“ฌ ์ด์Šˆ๋ฅผ ๋‚จ๊ฒจ์ฃผ์„ธ์š”
305
384
 
306
385
  ์ถ”ํ›„ ์ถ”๊ฐ€ํ•˜๊ณ ์žํ•˜๋Š” ํ…œํ”Œ๋ฆฟ, ์งˆ๋ฌธ, ๊ธฐ๋Šฅ์„ ์ ์–ด ์ฃผ์‹œ๋ฉด ์ตœ์„ ์„ ๋‹คํ•ด ๋‹ต๋ณ€ํ•˜๊ณ  ๋ฐ˜์˜ํ•˜๊ฒ ์Šต๋‹ˆ๋‹ค.
307
386
 
308
- ์ €์˜ ์˜คํ”ˆ์†Œ์Šค์— ๋Œ€ํ•ด ๊ด€์‹ฌ์„ ๊ฐ€์ ธ์ฃผ์…”์„œ ๊ฐ์‚ฌํ•ฉ๋‹ˆ๋‹ค. ( ๏ฝฅโˆ€๏ฝฅ)๏พ‰๏ฝผ
387
+ ์ €์˜ ์˜คํ”ˆ์†Œ์Šค์— ๋Œ€ํ•ด ๊ด€์‹ฌ์„ ๊ฐ€์ ธ์ฃผ์…”์„œ ๊ฐ์‚ฌํ•ฉ๋‹ˆ๋‹ค.
388
+
389
+ # (เน‘หƒฬตแด—ห‚ฬต)ูˆ
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <h1 align="center">
2
2
  <br>
3
- <img src='https://github.com/ljlm0402/typescript-express-starter/raw/images/logo.jpg' border='0' alt='logo' />
3
+ <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/logo.jpg" alt="Project Logo" />
4
4
  <br>
5
5
  <br>
6
6
  TypeScript Express Starter
@@ -10,24 +10,53 @@
10
10
  <h4 align="center">๐Ÿš€ Express RESTful API Boilerplate Using TypeScript</h4>
11
11
 
12
12
  <p align="center">
13
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/npm/v/typescript-express-starter.svg" alt="npm Version" /></a>
14
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/npm/l/typescript-express-starter.svg" alt="Package License" /></a>
15
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/github/v/release/ljlm0402/typescript-express-starter" alt="Release Version" /></a>
16
- <a href="http://npm.im/typescript-express-starter" target="_blank"><img src="https://img.shields.io/npm/dm/typescript-express-starter.svg" alt="npm Downloads" /></a>
13
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
14
+ <img src="https://img.shields.io/npm/v/typescript-express-starter.svg" alt="npm Version" />
15
+ </a>
16
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
17
+ <img src="https://img.shields.io/github/v/release/ljlm0402/typescript-express-starter" alt="npm Release Version" />
18
+ </a>
19
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
20
+ <img src="https://img.shields.io/npm/l/typescript-express-starter.svg" alt="npm Package License" />
21
+ </a>
22
+ <a href="http://npm.im/typescript-express-starter" target="_blank">
23
+ <img src="https://img.shields.io/npm/dm/typescript-express-starter.svg" alt="npm Downloads" />
24
+ </a>
17
25
  </p>
18
26
 
19
- <br />
20
-
21
27
  <p align="center">
22
- <a href="https://github.com/ljlm0402/typescript-express-starter/blob/master/README.md">๐Ÿ‡บ๐Ÿ‡ธ</a>
23
- <a href="https://github.com/ljlm0402/typescript-express-starter/blob/master/README.kr.md">๐Ÿ‡ฐ๐Ÿ‡ท</a>
28
+ <a href="https://github.com/ljlm0402/typescript-express-starter/stargazers" target="_blank">
29
+ <img src="https://img.shields.io/github/stars/ljlm0402/typescript-express-starter" alt="github Stars" />
30
+ </a>
31
+ <a href="https://github.com/ljlm0402/typescript-express-starter/network/members" target="_blank">
32
+ <img src="https://img.shields.io/github/forks/ljlm0402/typescript-express-starter" alt="github Forks" />
33
+ </a>
34
+ <a href="https://github.com/ljlm0402/typescript-express-starter/stargazers" target="_blank">
35
+ <img src="https://img.shields.io/github/contributors/ljlm0402/typescript-express-starter" alt="github Contributors" />
36
+ </a>
37
+ <a href="https://github.com/ljlm0402/typescript-express-starter/issues" target="_blank">
38
+ <img src="https://img.shields.io/github/issues/ljlm0402/typescript-express-starter" alt="github Issues" />
39
+ </a>
24
40
  </p>
25
41
 
26
42
  <br />
27
43
 
28
- ## ๐Ÿค” What is Express ?
44
+ ## Translations - read in your own language
29
45
 
30
- Express is a fast, open and concise web framework and is a Node.js based project.
46
+ - [๐Ÿ‡บ๐Ÿ‡ธ English](https://github.com/ljlm0402/typescript-express-starter/blob/master/README.md)
47
+ - [๐Ÿ‡ฐ๐Ÿ‡ท Korean](https://github.com/ljlm0402/typescript-express-starter/blob/master/README.kr.md)
48
+
49
+ > Want to translate to your own language? please open an issue ๐Ÿ’œ
50
+
51
+ <br />
52
+
53
+ ## Web Site - Project Introduction
54
+
55
+ - [๐Ÿ’๐Ÿปโ€โ™‚๏ธ Dylan Iqbal :: A TypeScript Express Starter App](https://bit.ly/3rrZFZ9)
56
+
57
+ > Want to be featured on your blog or site? please open an issue ๐Ÿ’™
58
+
59
+ <br />
31
60
 
32
61
  ## ๐Ÿ˜Ž Introducing The Project
33
62
 
@@ -37,7 +66,11 @@ That's why we avoid supersets with starter packages that introduce TypeScript.
37
66
 
38
67
  The package is configured to use TypeScript instead of JavaScript.
39
68
 
40
- > The project referred to [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript) by [seanpmaxwell](https://github.com/seanpmaxwell) ๐Ÿ‘
69
+ > The project referred to [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript)
70
+
71
+ ### ๐Ÿค” What is Express ?
72
+
73
+ Express is a fast, open and concise web framework and is a Node.js based project.
41
74
 
42
75
  ## ๐Ÿš€ Quick Start
43
76
 
@@ -61,7 +94,7 @@ $ npx typescript-express-starter "project name"
61
94
 
62
95
  ### Select a Templates
63
96
 
64
- <img src='https://github.com/ljlm0402/typescript-express-starter/raw/images/cli.gif' border='0' alt='cli' />
97
+ <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/cli.gif" alt="Example Cli" />
65
98
 
66
99
  Start your typescript-express-starter app in development mode at `http://localhost:3000/`
67
100
 
@@ -71,7 +104,7 @@ Start your typescript-express-starter app in development mode at `http://localho
71
104
  | :------------------- | :----------------------------------------------------------------------------------------------------------- |
72
105
  | Default | Express Default |
73
106
  | Routing Controllers | Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage |
74
- | Sequlize | Easy to use multi SQL dialect ROM for Node.js |
107
+ | Sequelize | Easy to use multi SQL dialect ORM for Node.js |
75
108
  | Mongoose | MongoDB Object Modeling(ODM) designed to work in an asynchronous environment |
76
109
  | TypeORM | An ORM that can run in Node.js and Others |
77
110
  | Prisma | Modern Database Access for TypeScript & Node.js |
@@ -88,25 +121,35 @@ Start your typescript-express-starter app in development mode at `http://localho
88
121
 
89
122
  ## ๐Ÿ’Ž The Package Features
90
123
 
91
- ![](https://img.shields.io/badge/-Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=fff)
92
- ![](https://img.shields.io/badge/-NPM-CB3837?style=for-the-badge&logo=NPM&logoColor=fff)
93
- ![](https://img.shields.io/badge/-TypeScript-007ACC?style=for-the-badge&logo=TypeScript&logoColor=fff)
94
- ![](https://img.shields.io/badge/-Express-F8F8F5?style=for-the-badge)
95
- ![](https://img.shields.io/badge/-Nodemon-76D04B?style=for-the-badge&logo=Nodemon&logoColor=fff)
96
- ![](https://img.shields.io/badge/-ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=fff)
97
- ![](https://img.shields.io/badge/-Prettier-F7B93E?style=for-the-badge&logo=Prettier&logoColor=000)
98
- ![](https://img.shields.io/badge/-Jest-C21325?style=for-the-badge&logo=Jest&logoColor=fff)
99
- ![](https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=000)
100
- ![](https://img.shields.io/badge/-Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=fff)
101
- ![](https://img.shields.io/badge/-NGINX-269539?style=for-the-badge&logo=NGINX&logoColor=fff)
102
- ![](https://img.shields.io/badge/-MySQL-4479A1?style=for-the-badge&logo=MySQL&logoColor=fff)
103
- ![](https://img.shields.io/badge/-MariaDB-003545?style=for-the-badge&logo=MariaDB&logoColor=fff)
104
- ![](https://img.shields.io/badge/-PostgreSQL-336791?style=for-the-badge&logo=PostgreSQL&logoColor=fff)
105
- ![](https://img.shields.io/badge/-MongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=fff)
124
+ - Application
125
+
126
+ - ![](https://img.shields.io/badge/-TypeScript-007ACC?style=for-the-badge&logo=TypeScript&logoColor=fff)
127
+ ![](https://img.shields.io/badge/-Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=fff)
128
+ ![](https://img.shields.io/badge/-NPM-CB3837?style=for-the-badge&logo=NPM&logoColor=fff)
129
+ ![](https://img.shields.io/badge/-NGINX-269539?style=for-the-badge&logo=NGINX&logoColor=fff)
130
+
131
+ - DevOps
132
+
133
+ - ![](https://img.shields.io/badge/-Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=fff)
134
+ ![](https://img.shields.io/badge/-Nodemon-76D04B?style=for-the-badge&logo=Nodemon&logoColor=fff)
135
+ ![](https://img.shields.io/badge/-PM2-2B037A?style=for-the-badge&logo=PM2&logoColor=fff)
136
+ ![](https://img.shields.io/badge/-ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=fff)
137
+ ![](https://img.shields.io/badge/-Prettier-F7B93E?style=for-the-badge&logo=Prettier&logoColor=000)
138
+ ![](https://img.shields.io/badge/-Jest-C21325?style=for-the-badge&logo=Jest&logoColor=fff)
139
+
140
+ - Utilities
141
+
142
+ - ![](https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=000)
143
+
144
+ - Database
145
+ - ![](https://img.shields.io/badge/-MySQL-4479A1?style=for-the-badge&logo=MySQL&logoColor=fff)
146
+ ![](https://img.shields.io/badge/-MariaDB-003545?style=for-the-badge&logo=MariaDB&logoColor=fff)
147
+ ![](https://img.shields.io/badge/-PostgreSQL-336791?style=for-the-badge&logo=PostgreSQL&logoColor=fff)
148
+ ![](https://img.shields.io/badge/-MongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=fff)
106
149
 
107
150
  > [Simple Icons](https://simpleicons.org/)
108
151
 
109
- ### ๐Ÿณ Docker - Containers
152
+ ### ๐Ÿณ Docker :: Container Platform
110
153
 
111
154
  [Docker](https://docs.docker.com/) is a platform for developers and sysadmins to build, run, and share applications with containers.
112
155
 
@@ -117,7 +160,7 @@ Start your typescript-express-starter app in development mode at `http://localho
117
160
 
118
161
  Modify `docker-compose.yml` and `Dockerfile` file to your source code.
119
162
 
120
- ### โ™ป๏ธ NGINX - Reverse Proxy
163
+ ### โ™ป๏ธ NGINX :: Web Server
121
164
 
122
165
  [NGINX](https://www.nginx.com/) is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.
123
166
 
@@ -127,16 +170,12 @@ When NGINX proxies a request, it sends the request to a specified proxied server
127
170
 
128
171
  Modify `nginx.conf` file to your source code.
129
172
 
130
- ### โœจ ESLint, Prettier - Code Formatter
131
-
132
- Palantir, the backers behind TSLint announced in 2019 that they would be deprecating TSLint in favor of supporting typescript-eslint in order to benefit the community.
173
+ ### โœจ ESLint, Prettier :: Code Formatter
133
174
 
134
- So, migration from TSLint to ESLint.
175
+ [Prettier](https://prettier.io/) is an opinionated code formatter.
135
176
 
136
177
  [ESLint](https://eslint.org/), Find and fix problems in your JavaScript code
137
178
 
138
- [Prettier](https://prettier.io/) is an opinionated code formatter.
139
-
140
179
  It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.
141
180
 
142
181
  1. Install [VSCode](https://code.visualstudio.com/) Extension [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
@@ -149,9 +188,12 @@ It enforces a consistent style by parsing your code and re-printing it with its
149
188
 
150
189
  5. Prettier - Code formatter
151
190
 
152
- <img src='https://github.com/ljlm0402/typescript-express-starter/raw/images/formatter.png' border='0' alt='formatter' />
191
+ <img src="https://user-images.githubusercontent.com/42952358/126604937-4ef50b61-b7e4-4635-b3c9-3c94dd6b06fa.png" alt="Formatter Setting" />
192
+
193
+ > Palantir, the backers behind TSLint announced in 2019 that they would be deprecating TSLint in favor of supporting typescript-eslint in order to benefit the community.
194
+ > So, migration from TSLint to ESLint.
153
195
 
154
- ### ๐Ÿ“— Swagger - API Document
196
+ ### ๐Ÿ“— Swagger :: API Document
155
197
 
156
198
  [Swagger](https://swagger.io/) is Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset.
157
199
 
@@ -161,13 +203,33 @@ Start your app in development mode at `http://localhost:3000/api-docs`
161
203
 
162
204
  Modify `swagger.yaml` file to your source code.
163
205
 
164
- ### ๐ŸŒ REST Client(VSCode Extension) - HTTP Client Tools
206
+ ### ๐ŸŒ REST Client :: HTTP Client Tools
165
207
 
166
208
  REST Client allows you to send HTTP request and view the response in Visual Studio Code directly.
167
209
 
168
210
  VSCode Extension [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) Install.
169
211
 
170
- Modify `*.http` file in http folder to your source code.
212
+ Modify `*.http` file in src/http folder to your source code.
213
+
214
+ ### ๐Ÿ”ฎ PM2 :: Advanced, Production process manager for Node.js
215
+
216
+ [PM2](https://pm2.keymetrics.io/) is a daemon process manager that will help you manage and keep your application online 24/7.
217
+
218
+ - production mode :: `npm run deploy:prod` or `pm2 start ecosystem.config.js --only prod`
219
+ - development mode :: `npm run deploy:dev` or `pm2 start ecosystem.config.js --only dev`
220
+
221
+ Modify `ecosystem.config.js` file to your source code.
222
+
223
+ ### ๐ŸŽ SWC :: a super-fast JavaScript / TypeScript compiler
224
+
225
+ [SWC](https://swc.rs/) is an extensible Rust-based platform for the next generation of fast developer tools.
226
+
227
+ `SWC is 20x faster than Babel on a single thread and 70x faster on four cores.`
228
+
229
+ - swc build :: `npm run build`
230
+ - tsc build :: `npm run build:tsc`
231
+
232
+ Modify `.swcrc` file to your source code.
171
233
 
172
234
  ## ๐Ÿ—‚ Code Structure (default)
173
235
 
@@ -231,6 +293,7 @@ Modify `*.http` file in http folder to your source code.
231
293
  โ”‚ โ”‚ โ””โ”€โ”€ vaildateEnv.ts
232
294
  โ”‚ โ”‚
233
295
  โ”‚ โ”œโ”€โ”€ app.ts
296
+ โ”‚ โ”œโ”€โ”€ index.ts
234
297
  โ”‚ โ””โ”€โ”€ server.ts
235
298
  โ”‚
236
299
  โ”œโ”€โ”€ .dockerignore
@@ -242,6 +305,7 @@ Modify `*.http` file in http folder to your source code.
242
305
  โ”œโ”€โ”€ .huskyrc
243
306
  โ”œโ”€โ”€ .lintstagedrc.json
244
307
  โ”œโ”€โ”€ .prettierrc
308
+ โ”œโ”€โ”€ .swcrc
245
309
  โ”œโ”€โ”€ docker-compose.yml
246
310
  โ”œโ”€โ”€ Dockerfile
247
311
  โ”œโ”€โ”€ ecosystem.config.js
@@ -255,21 +319,13 @@ Modify `*.http` file in http folder to your source code.
255
319
  โ””โ”€โ”€ tsconfig.json
256
320
  ```
257
321
 
258
- ## ๐Ÿ“ฌ Recommended Commit Message
322
+ ## โญ๏ธ Stargazers
259
323
 
260
- | When | Commit Message |
261
- | :--------------- | :----------------- |
262
- | Add Feature | โœจ Add Feature |
263
- | Fix Bug | ๐Ÿž Fix Bug |
264
- | Refactoring Code | ๐Ÿ›  Refactoring Code |
265
- | Install Package | ๐Ÿ“ฆ Install Package |
266
- | Fix Readme | ๐Ÿ“š Fix Readme |
267
- | Update Version | ๐ŸŒผ Update Version |
268
- | New Template | ๐ŸŽ‰ New Template |
324
+ [![Stargazers repo roster for @ljlm0402/typescript-express-starter](https://reporoster.com/stars/ljlm0402/typescript-express-starter)](https://github.com/ljlm0402/typescript-express-starter/stargazers)
269
325
 
270
- ## ๐Ÿ’ณ License
326
+ ## ๐Ÿด Forkers
271
327
 
272
- [MIT](LICENSE)
328
+ [![Forkers repo roster for @ljlm0402/typescript-express-starter](https://reporoster.com/forks/ljlm0402/typescript-express-starter)](https://github.com/ljlm0402/typescript-express-starter/network/members)
273
329
 
274
330
  ## ๐Ÿค Contributors
275
331
 
@@ -307,8 +363,32 @@ Modify `*.http` file in http folder to your source code.
307
363
 
308
364
  - michael r [https://github.com/alanmynah](https://github.com/alanmynah)
309
365
 
366
+ - Benjamin [https://github.com/benjaminudoh10](https://github.com/benjaminudoh10)
367
+
368
+ - Amrik Singh [https://github.com/AmrikSD](https://github.com/AmrikSD)
369
+
370
+ - oricc [https://github.com/oricc](https://github.com/oricc)
371
+
372
+ ## ๐Ÿ’ณ License
373
+
374
+ [MIT](LICENSE)
375
+
376
+ ## ๐Ÿ“ฌ Recommended Commit Message
377
+
378
+ | When | Commit Message |
379
+ | :--------------- | :----------------- |
380
+ | Add Feature | โœจ Add Feature |
381
+ | Fix Bug | ๐Ÿž Fix Bug |
382
+ | Refactoring Code | ๐Ÿ›  Refactoring Code |
383
+ | Install Package | ๐Ÿ“ฆ Install Package |
384
+ | Fix Readme | ๐Ÿ“š Fix Readme |
385
+ | Update Version | ๐ŸŒผ Update Version |
386
+ | New Template | ๐ŸŽ‰ New Template |
387
+
310
388
  ## ๐Ÿ“ฌ Please request an issue
311
389
 
312
390
  In the future, please write down your desired template, questions, and features to be added, and we will try our best to answer and reflect them.
313
391
 
314
- Thank you very much for your interest in our package. ( ๏ฝฅโˆ€๏ฝฅ)๏พ‰๏ฝผ
392
+ Thank you very much for your interest in our package.
393
+
394
+ # (เน‘หƒฬตแด—ห‚ฬต)ูˆ
package/bin/cli.js CHANGED
@@ -1,9 +1,10 @@
1
1
  #!/usr/bin/env node
2
2
 
3
3
  /*****************************************************************
4
- * Create new typescript-express-starter project.
5
- * By AGUMON <ljlm0402@gmail.com>
6
- * December 18, 2019.
4
+ * Typescript Express Starter
5
+ * 2019.12.18 ~ ๐ŸŽฎ
6
+ * Made By AGUMON ๐Ÿฆ–
7
+ * https://github.com/ljlm0402/typescript-express-starter
7
8
  *****************************************************************/
8
9
 
9
10
  const path = require("path");