-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f4c9ec5
commit a0b6057
Showing
1 changed file
with
147 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,167 @@ | ||
| <p align="center"> | ||
| <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> | ||
| </p> | ||
| # 어드레감디 | ||
|  | ||
|
|
||
| [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 | ||
| [circleci-url]: https://circleci.com/gh/nestjs/nest | ||
| 🔗 [[kakao x goorm] 9oormthon 5기 대상 🏆](https://goorm.notion.site/443e8520bfd84ffebc12b868f2281ea7) | ||
|
|
||
| <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> | ||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> | ||
| <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> | ||
| <a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> | ||
| <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> | ||
| <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> | ||
| <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> | ||
| <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> | ||
| </p> | ||
| <!--[](https://opencollective.com/nest#backer) | ||
| [](https://opencollective.com/nest#sponsor)--> | ||
| <br> | ||
|
|
||
| ## Description | ||
| ## 서비스 소개 | ||
|
|
||
| [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. | ||
| 어드레감디👩🦽🍊 : ’어디로 갈까요?’의 제주 방언 | ||
|
|
||
| ## Installation | ||
| 휠체어 사용자의 취향과 편의시설을 모두 고려한 제주 관광지 추천 서비스입니다. | ||
|
|
||
| ```bash | ||
| $ npm install | ||
| ``` | ||
| <br> | ||
|
|
||
| ## Running the app | ||
| ## 기능 소개 | ||
|
|
||
| ```bash | ||
| # development | ||
| $ npm run start | ||
| ### Step 1. 취향과 조건에 맞게 선택 (온보딩) | ||
|
|
||
| # watch mode | ||
| $ npm run start:dev | ||
| <br> | ||
|
|
||
| # production mode | ||
| $ npm run start:prod | ||
| ``` | ||
|  | ||
|
|
||
| ## Test | ||
| <br> | ||
|
|
||
| > **1) 동행인 여부를 선택 후, 개인 혹은 팀의 여행 닉네임 작성** | ||
| > <br> | ||
| > 동행인이 없다면 혼자서도 자유롭게 돌아다닐 수 있는 장소로 추천합니다. | ||
| ```bash | ||
| # unit tests | ||
| $ npm run test | ||
| <br> | ||
|
|
||
| # e2e tests | ||
| $ npm run test:e2e | ||
| > **2) 필요 시설에 대한 중복 옵션 가능** | ||
| > <br> | ||
| > 무단차, 경사로 등 이동에 필요한 정보도 제공합니다. | ||
| # test coverage | ||
| $ npm run test:cov | ||
| ``` | ||
| <br> | ||
|
|
||
| ## Support | ||
| > **3) 취향에 따라 선호하는 장소 선택** | ||
| > <br> | ||
| > 자연경관 구경부터 트래킹, 문화예술, 쇼핑 등의 장소 카테고리화 하여 제공합니다. | ||
| Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). | ||
| <br> | ||
|
|
||
| ### Step 2. 선택 결과 맞춤형 목록 보기 | ||
|
|
||
| <br> | ||
|
|
||
|  | ||
|
|
||
| <br> | ||
|
|
||
| > **1) 나만을 위한 제주 관광지 맞춤형 목록** | ||
| > <br> | ||
| > 나와 가장 가까운 위치 순으로 장소 목록을 제공합니다. | ||
| <br> | ||
|
|
||
| > **2) 장소별 특징과 필요 시설을 바로 확인** | ||
| > <br> | ||
| > 장소별 사진과 장소별 보유 편의시설에 대한 아이콘으로 나타냅니다. | ||
| <br> | ||
|
|
||
| > **3) 사용자의 맞춤형 목록을 카카오톡으로 공유** | ||
| > <br> | ||
| > 검색 결과를 공유하고 함께 방문할 장소를 정할 수 있습니다. | ||
| <br> | ||
|
|
||
| ### Step 3. 궁금한 장소 상세 정보 확인하기 | ||
|
|
||
| <br> | ||
|
|
||
|  | ||
|
|
||
| <br> | ||
|
|
||
| > **1) 방문할 장소에 대한 상세 설명과 이동 환경을 확인** | ||
| > <br> | ||
| > 방문 장소의 실제 이동 환경 설명합니다. | ||
| > 출입구까지 턱이 있는지, 단차가 있다면 크기가 얼마나 되는지 등의 세심한 정보를 제공합니다. | ||
| <br> | ||
|
|
||
| > **2) 길 안내와 전화 연결 가능** | ||
| > <br> | ||
| > 주소, 전화번호를 복사해 붙여넣을 필요 없이 바로 해당 기능으로 이동합니다. | ||
| <br> | ||
|
|
||
| ## 핵심 기술 | ||
|
|
||
| ### Frontend | ||
| 기술 스택 : React, TypeScript, Apollo Client, Zustand, Framer motion, Styled-components | ||
|
|
||
| ### Backend | ||
| 기술 스택 : NestJS, GraphQL, Prisma, Supabase (PostgreSQL), Github actions, AWS(EKS, ECR) | ||
|
|
||
| <br> | ||
|
|
||
| ## 시스템 아키텍처 | ||
|
|
||
|  | ||
|
|
||
| **해당 시스템 아키텍처는 구름톤 대회 당시 아키텍처 입니다.** | ||
|
|
||
| 현재는 프론트엔드는 Vercel, 백엔드는 Render로 배포되어 있습니다. | ||
| <br> | ||
| 해커톤 당시 발급받았던 EKS 계정이 만료되어, 비용적인 측면을 고려하여 무료 Hosting 플랫폼으로 배포방식을 전환하였습니다. | ||
|
|
||
| <br> | ||
|
|
||
| ## 활용 데이터 | ||
| **열린관광 무장애 여행지 (출처: 한국관광공사)** <br> | ||
| https://access.visitkorea.or.kr/main/main.do | ||
|
|
||
| <br> | ||
|
|
||
| ## 팀원 및 역할 | ||
|
|
||
| <table> | ||
| <th width="20%" style="text-align:center"><a href="https://github.com/teorgeos" target="_blank">서혜빈</th> | ||
| <th width="20%" style="text-align:center"><a href="https://github.com/suhyun22" target="_blank">김수현</th> | ||
| <th width="20%" style="text-align:center"><a href="https://github.com/raymondanythings" target="_blank">엽용현</a></th> | ||
| <th width="20%" style="text-align:center"><a href="https://github.com/goodafteryoon" target="_blank">최윤나</a></th> | ||
| <th width="20%" style="text-align:center"><a href="https://github.com/GwangjoGong" target="_blank">공광조</a></th> | ||
| <tr> | ||
| <td> | ||
| <img src="https://user-images.githubusercontent.com/106373580/233285256-1946cfcd-5ae3-40ff-b39b-6ff19df3da93.png"/> | ||
| </td> | ||
| <td> | ||
| <img src="https://user-images.githubusercontent.com/106373580/233285631-99f54808-2c23-4b32-909c-c66e1b0759a6.png"/> | ||
| </td> | ||
| <td> | ||
| <img src="https://user-images.githubusercontent.com/106373580/233285947-61926021-db9d-4f2b-8b7b-e5ef37c8d686.png"/> | ||
| </td> | ||
| <td> | ||
| <img src="https://user-images.githubusercontent.com/106373580/233285807-ea297fe2-d6b3-4539-b7a3-fd7c96b3408c.png"/> | ||
| </td> | ||
| <td> | ||
| <img src="https://user-images.githubusercontent.com/106373580/233286272-269eef09-e7ec-4384-b705-b300fa28199c.png"/> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <strong>Product <br> Manager</strong> | ||
| </td> | ||
| <td> | ||
| <strong>UX/UI <br> Designer</strong> | ||
| </td> | ||
| <td> | ||
| <strong>Front-end <br> Developer</strong> | ||
| </td> | ||
| <td> | ||
| <strong>Front-end <br> Developer</strong> | ||
| </td> | ||
| <td> | ||
| <strong>Back-end <br> Developer</strong> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <br> | ||
|
|
||
| ## Stay in touch | ||
|
|
||
| - Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) | ||
| - Website - [https://nestjs.com](https://nestjs.com/) | ||
| - Twitter - [@nestframework](https://twitter.com/nestframework) | ||
|
|
||
| ## License | ||
|
|
||
| Nest is [MIT licensed](LICENSE). |