From 11f404e4eadb0becb1024c8f137157194204b640 Mon Sep 17 00:00:00 2001 From: pyo-sh Date: Fri, 11 Aug 2023 15:39:23 +0900 Subject: [PATCH 1/4] docs: README.md v1.0.0 (#80) Co-authored-by: seoko97 --- README.md | 139 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 118 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 526d2d2..bb1b3d3 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,127 @@ -# Nest JS Boilerplate +

+
+ Plandar +
+ Plandar +
+

-## 요청 URL +

사용자 별 개인 일정 관리 기능이 있는 달력 웹 서비스

-prefix로 `/api`를 붙입니다. +

+
+ + + Notion docs » + + +
+

-## Http Exception Filter +

+ Contributors • + Key Features • + How To Use • + Credits • + Related +

-요청 실패시 아래 형식으로 응답합니다. +
+ +
-``` -{ - success: false, - timestamp: "2023-02-22T06:25:08.663Z", - statusCode: 404, - message: "Cannot GET /", - error: "Not Found" -} -``` +## Contributors 🙋🏼‍♂️ -## Success Interceptor + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + 지석호 + + + + + + 표석훈 + + + + + + 한진탁 + + +
-요청 성공시 아래 형식으로 응답합니다. +## Key Features ⚒️ +- 원하는 날짜의 달력을 볼 수 있습니다. + - 일간, 주간, 월간 달력 제공합니다. + - 사이드바와 헤더를 통해 달력을 제어할 수 있습니다. +- 일정을 추가하여 관리할 수 있습니다. + - 일정을 달력에서 볼 수 있습니다. + - 일정에 대한 메모를 남길 수 있습니다. +- 드래그를 통해 일정을 생성 및 수정할 수 있습니다. +- 카테고리 기능을 이용해 비슷한 일정을 한번에 관리할 수 있습니다. +- 태그 기능을 이용해 일정 필터링을 사용할 수 있습니다. + +## How To Use ⚙️ + +어플리케이션을 실행하기 위해선 [Git](https://git-scm.com)과 [Node.js](https://nodejs.org/en/download/) ([npm](http://npmjs.com)) 을 설치해야 합니다. + +이후 아래의 명령어를 통해 실행할 수 있습니다. + +```bash +# Clone this repository +$ git clone https://github.com/JiPyoTak/plandar-server + +# Go into the repository +$ cd plandar-server + +# Install dependencies +$ npm install + +# Run the app +$ npm start ``` -{ - success: true, - data: "Hello World!" -} -``` + +> **Note** +> +> 1. 이 어플리케이션을 정상적으로 실행하려면 .env 파일을 생성하고 내용을 기입해야 합니다. +> 2. 구글, 카카오 OAuth 설정이 필요합니다. + +## Credits 📚 + +아래와 같은 오픈소스 패키지를 사용하고 있습니다. + +- [Node.js](https://nodejs.org/) +- [NestJS](https://nestjs.com/) +- [mysql2](https://www.npmjs.com/package/mysql2) +- [typeORM](https://typeorm.io/?ref=arctype.com) +- [passport](https://www.passportjs.org/) + +## Related 🔗 + +[plandar-client](https://github.com/JiPyoTak/plandar-client) - Plandar 웹 뷰를 제공하는 어플리케이션 From a719150fe1a4d1881907401e1c9c3d7147a40eaf Mon Sep 17 00:00:00 2001 From: pyo-sh Date: Fri, 11 Aug 2023 15:45:42 +0900 Subject: [PATCH 2/4] =?UTF-8?q?fix:=20README.md=20v1.0.0=20=EC=98=A4?= =?UTF-8?q?=EB=A5=98=20=ED=95=B4=EA=B2=B0=20(#80)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: seoko97 --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bb1b3d3..235c3c0 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,15 @@

- Contributors • - Key Features • - How To Use • - Credits • - Related + Contributors • + Key Features • + How To Use • + Credits • + Related

- +
## Contributors 🙋🏼‍♂️ From f2310efdbb2108563c1d624d791e1cd118f0cf0a Mon Sep 17 00:00:00 2001 From: pyo-sh Date: Fri, 11 Aug 2023 15:49:41 +0900 Subject: [PATCH 3/4] =?UTF-8?q?fix:=20README.md=20v1.0.0=20hashrouter=20?= =?UTF-8?q?=EC=A0=81=EC=9A=A9=20(#80)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: seoko97 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 235c3c0..ec3901c 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@

- Contributors • - Key Features • - How To Use • - Credits • - Related + Contributors • + Key Features • + How To Use • + Credits • + Related

From 11a2a7a088e9617ec44d43c54bf595540a917ffa Mon Sep 17 00:00:00 2001 From: pyo-sh Date: Fri, 11 Aug 2023 15:51:07 +0900 Subject: [PATCH 4/4] =?UTF-8?q?fix:=20README.md=20v1.0.0=20hashrouter=20?= =?UTF-8?q?=EC=A0=81=EC=9A=A9=202=20(#80)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: seoko97 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ec3901c..39b588e 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@

- Contributors • - Key Features • - How To Use • - Credits • - Related + Contributors • + Key Features • + How To Use • + Credits • + Related