docs: update readme

Author: americano212

.env.example

@@ -23,10 +23,10 @@ TEST_DB_NAME='docker-mysql-db'
 TEST_DB_PORT=33061
 
 # ------------------------------------------------------------------------------------
-# Hashing
+# Hashing(*require)
 BCRYPT_SALT=
 
-# Seeding
+# Seeding(*require)
 SUPER_ADMIN_EMAIL=
 SUPER_ADMIN_PASSWORD=
 SUPER_ADMIN_USERNAME=
@@ -37,7 +37,9 @@ JWT_REFRESH_SECRET=
 DEV_JWT_ACCESS_SECRET=
 DEV_JWT_REFRESH_SECRET=
 
-# OAuth
+# OAuth(*require)
+# If you don't use something, you have to delete some code.
+# Check `src/auth/auth.module.ts`, `test/e2e/oauth.e2e-spec.ts`.
 KAKAO_CLIENT_ID=
 KAKAO_CLIENT_SECRET=
 KAKAO_CALLBACK_URL=

README.md

@@ -1,130 +1,119 @@
-# NestJS REST API templete v1
-
-## Description
-
-NestJS REST API templete for Korea user.
-
-## Features
-
-- [x] Database(TypeORM)
-  - Support DB
-  - [x] MySQL
-- [x] Seeding
-- [x] Local Authentication
-- [x] OAuth(Social Login)
-  - [x] Kakao
-  - [x] Naver
-  - [x] Google
-  - [x] Github
-- [x] Customizing Roles(Admin, User...)
-- [x] JWT Authorization
-- [x] Slack Alert when throw ERROR
-- [x] Logging(winston)
-- [x] Swagger
-- [x] Validate DTOs with Entities
-- [x] Unit Test(Jest)
-- [x] E2E Test
-- [x] File upload
-- [x] CI
-- [x] Example Domain(Board with content)
-
-## Configuration
-
-Create `.env` file with reference to `.env.example`
-
-Especially, `SUPER_ADMIN` will be a master account by seeding, so please decide carefully.
-
-## Installation
-
-```bash
-# 1. Install node_modules
-npm ci
-# 2. Load Entity
-npm run entity:sync
-# 3. Seeding(Load Role with Super Admin)
-npm run seed:run
-```
-
-## Development
-
-Set `NODE_ENV='development'` in `.env`
-
-```bash
-npm run start:dev
-```
-
-## Production
-
-Set `NODE_ENV='production'` in `.env`
-
-```bash
-npm start
-```
-
-OR
-
-```bash
-npm run lint
-rimraf dist
-nest build
-node dist/src/main
-```
-
-## Test
-
-Test run on `jest`.
-Template already contains an example of unit and e2e tests.
-
-### Unit Test
-
-```bash
-# 1. Test by 'Jest'
-npm run test:e2e
-# 2. Auto e2e test. (It include creating test DB CLI too.)
-npm run test:e2e:auto
-```
-
-### End-to-End Test
-
-```bash
-# 1. Load local test DB by docker
-npm run test:docker:up
-# 2. Run E2E test auto mode
-npm run test:e2e:auto
-# 3. Quit E2E test
-npm run test:docker:down
-```
-
-OR
-
-```bash
-# 1. Load local test DB by docker
-npm run test:docker:up
-# 2. Initialize Database
-npm run test:entity:drop
-# 3. Synchronization Database
-npm run test:entity:sync
-# 4. Seeding Database
-npm run test:seed:run
-# 5. Run E2E test
-npm run test:e2e:debug
-# 6. Quit E2E test
-npm run test:docker:down
-```
-
-## Links
-
-- Swagger: <http://localhost:8081/docs>
-
-## Database utils
-
-```bash
-# 1. When project init, synchronize Entities to Database
-npm run entity:sync
-# 2. [Warning] When you need to erase ALL Database, DROP ALL Exist table.
-npm run entity:drop
-# 3. When project init, seeding data.(Roles, Super Admin)
-npm run seed:run
-# 4. [Warning] When you need to erase ALL Users with roles, DELETE ALL raws in user, role, user_role table.
-npm run seed:revert
-```
+# NestJS REST API templete
+<p align="center">
+  <a href="https://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+<p align="center">
+NestJS REST API templete with TypeORM, Jest, OAuth, Logging, Swagger docs.
+</p>
+
+## Description
+NestJS REST API templete(boilerplate) for quick start new project.
+
+Support kakao & naver OAuth, common in korea.
+
+Include example of CI/CD, deploy to AWS after testing. (by Github Actions)
+
+## 🔧 Features
+- [x] Database(TypeORM)
+  - Support DB
+  - [x] MySQL
+  - [ ] Postgres
+- [x] Seeding
+- [x] Local Authentication
+- [x] OAuth(Social Login)
+  - [x] [Kakao](https://developers.kakao.com/docs/latest/ko/kakaologin/common)
+  - [x] [Naver](https://developers.naver.com/products/login/api/api.md)
+  - [x] [Google](https://developers.google.com/identity/protocols/oauth2)
+  - [x] [Github](https://docs.github.com/v3/oauth)
+- [x] Customizing user's roles(Admin, User...)
+- [x] JWT Authorization
+- [x] Slack Alert when throw ERROR
+- [x] Logging(winston)
+- [x] Swagger
+- [x] Unit Test(Jest)
+- [x] E2E Test
+- [x] File upload
+  - Support Cloud
+  - [x] AWS S3
+- [x] CI
+- [x] Example Domain(Board with content)
+
+<br/>
+
+# 🔨 Getting started
+## Configuration
+```bash
+# Create `.env` file with reference to `.env.example`
+cp .env.example .env
+```
+- Especially, `SUPER_ADMIN` will be a master account by seeding, so please decide carefully.
+
+## Init project
+```bash
+# 1. Install Nest CLI 
+npm i -g @nestjs/cli
+# 2. Install node_modules
+npm ci
+# 3. Setup databases by docker
+npm run dev:docker:up
+# 4. Load entity
+npm run entity:sync
+# 5. Seeding(Load Role with Super Admin)
+npm run seed:run
+```
+
+## Development
+- Set `NODE_ENV='development'` in `.env`
+```bash
+npm run start:dev
+```
+
+## Production
+- Set `NODE_ENV='production'` in `.env`
+```bash
+npm start
+```
+
+## Test
+- Test run on `Jest`.
+- Template already contains an example of `unit` and `e2e` tests.
+
+### Unit Test
+```bash
+# 1. Run unit test
+npm run test:cov
+# 2. If you debug during testing.
+npm run test:debug
+```
+
+### End-to-End Test
+```bash
+# 1. Run E2E test auto mode
+npm run test:e2e:auto
+```
+
+### Reset test DB
+- Erase all data in test DB
+```bash
+# 1. Stop test DB running
+npm run test:docker:down
+# 2. Run new test DB
+npm run test:docker:up
+```
+
+## Links
+
+- Swagger: <http://localhost:8081/docs>
+
+## Database utils
+
+```bash
+# 1. When project init, synchronize Entities to Database
+npm run entity:sync
+# 2. [Warning] When you need to erase ALL Database, DROP ALL Exist table.
+npm run entity:drop
+# 3. When project init, seeding data.(Roles, Super Admin)
+npm run seed:run
+# 4. [Warning] When you need to erase ALL Users with roles, DELETE ALL raws in user, role, user_role table.
+npm run seed:revert
+```