Skip to content

Commit

Permalink
Update README.md (#246)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dev-junehee
dev-junehee authored Oct 6, 2023
1 parent f361655 commit 4a8f1ab
Showing 1 changed file with 160 additions and 18 deletions.
178 changes: 160 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,165 @@
# Officener Sixsense Client ver.
# 🏢 오피스너 (officener)

## 커밋 컨벤션 목록 :)
> 입주 경험은 높이고, 관리 소요는 낮추고<br />
> 스마트 오피스 빌딩 통합 플랫폼 오피스너!
- feat: 새로운 기능을 추가한 경우
- fix: 에러를 수정한 경우
- design: CSS 등 UI 디자인을 변경한 경우
- BREAKING: CHANGE 중대한 API를 변경한 경우
- HOTFIX: 급하게 치명적인 에러를 고친 경우
- style: 코드 포맷 변경을 하거나 세미 콜론 누락하여 추가하면서 코드 수정이 없는 경우
- refactor: 코드를 리팩토링한 경우
- comment: 주석을 추가하거나 변경한 경우
- docs: 문서를 수정한 경우
- test: 테스트 코드를 추가, 변경, 리팩토링한 경우
- chore: 기타 변경사항 (빌드 스크립트 수정, 패키지 매니징 설정 등)
- rename: 파일 or 폴더명 수정하거나 옮기는 경우
- remove: 파일을 삭제하는 작업만 수행한 경우
<br />

### 팀 식스센스 코드 컨벤션
### 🖥 [클라이언트 DEMO](https://officener.vercel.app/)

### 에어비엔비 코드 컨벤션 링크
### [⚙️ 어드민 DEMO](https://officener-admin.vercel.app/)

[에어비엔비](https://github.com/tipjs/javascript-style-guide)
<br />

## 🗓️ 프로젝트 소개

> **주 제** : 빌딩 내 입주자 활성화를 위한 서비스 기획/개발 <br/> > **목 표** : 유저 그로스 기획/개발을 통해 핵심 지표인 '유저 가입자 수'와 'WAU' 높이기 <br/> > **개발 기간** : 2023. 08. 16 ~ 2023. 10. 06 (2개월) <br/>
<br>

## 👤 프로젝트 팀원

| 김준희 | 김진우 | 이시우 | 유희태 (팀장) | 조은상 |
| :-----------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: |
| <a href="https://github.com/dev-junehee"><img src="https://avatars.githubusercontent.com/u/116873887?v=4" width=200px alt="김준희" /> | <a href="https://github.com/jinu6262"><img src="https://avatars.githubusercontent.com/u/105920346?v=4" width=200px alt="김진우" /> | <a href="https://github.com/cuconveniencestore"><img src="https://avatars.githubusercontent.com/u/125563995?v=4" width=200px alt="이시우" /> | <a href="https://github.com/1017yu"><img src="https://avatars.githubusercontent.com/u/83483378?v=4" width=200px alt="유희태" /> | <a href="https://github.com/ChoEun-Sang"><img src="https://avatars.githubusercontent.com/u/128155681?v=4" width=200px alt="조은상" /> |
| 초대장 생성 | 초대장 뷰<br />관리자 | 초대장 수정<br />초대장 뷰 | 홈 리디자인<br />오늘 점심 | 오늘점심 |

<br />

## 🛠️️ 사용기술 및 개발환경

**Front-End**

<p>
<img src="https://img.shields.io/badge/NEXT.js-000000?style=flat&logo=nextdotjs&logoColor=white" />
<img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=TypeScript&logoColor=white" />
<img src="https://img.shields.io/badge/Emotion-DB7093?style=flat&logo=Emotion&logoColor=white" />
<img src="https://img.shields.io/badge/Zustand-000000?style=flat&logo=Zustand&logoColor=white" />
<img src="https://img.shields.io/badge/React Query-FF4154?style=flat&logo=reactquery&logoColor=white" />
<img src="https://img.shields.io/badge/npm-CB3837?style=flat&logo=npm&logoColor=white"/>
<img src="https://img.shields.io/badge/Visual Studio Code-007ACC?style=flat&logo=Visual Studio Code&logoColor=white"/>
</p>

**Back-End**

<p>
<img src="https://img.shields.io/badge/java11-007396?style=flat&logo=java&logoColor=white" />
<img src="https://img.shields.io/badge/SpringBoot-6DB33F?style=flat&logo=springboot&logoColor=white" />
<img src="https://img.shields.io/badge/Spring_Security-6DB33F?style=flat&logo=springsecurity&logoColor=white" />
<img src="https://img.shields.io/badge/MySQL-4479A1?style=flat&logo=mysql&logoColor=white" />
<img src="https://img.shields.io/badge/Gradle-02303A?style=flat&logo=gradle&logoColor=white" />
<img src="https://img.shields.io/badge/JPA-527FFF?style=flat&logo=java&logoColor=white" />
<img src="https://img.shields.io/badge/IntelliJ_IDEA-000000?style=flat&logo=intellijidea&logoColor=white" />

</p>

**Deployment**

<p>
<img src="https://img.shields.io/badge/Vercel-000000?style=flat&logo=Vercel&logoColor=white" />
<img src="https://img.shields.io/badge/AWS-232F3E?style=flat&logo=amazonaws&logoColor=white" />
<img src="https://img.shields.io/badge/AWS_EC2-FF9900?style=flat&logo=amazonec2&logoColor=white" />
</p>

**Cowork Tools**

<p>
<img src="https://img.shields.io/badge/Slack-4A154B?style=flat&logo=Slack&logoColor=white" />
<img src="https://img.shields.io/badge/Notion-000000?style=flat&logo=Notion&logoColor=white" />
<img src="https://img.shields.io/badge/Zoom-2D8CFF?style=flat&logo=Zoom&logoColor=white" />
<img src="https://img.shields.io/badge/Figma-F24E1E?style=flat&logo=figma&logoColor=white" />
<img src="https://img.shields.io/badge/GitHub-181717?style=flat&logo=GitHub&logoColor=white" />
</p>

<br></br>

## 🖥️ 기능 소개

### 1. 방문자 초대장

- 방문자 초대하기
- 초대장 목록 확인
- 초대장 수정/삭제
- 실내 지도 확인
- 방문할 빌딩 근처 시설 안내
- 방문증 알림톡
- 방문자 관리 웹

<br />

### 2. 주차 정산

- 방문 주차 등록
- 주차 결제 (준비 중)
- 주차 할인 적용 (준비 중)
- 주차 사전 정산 (준비 중)

<br />

### 3. 오늘 점심

- 메뉴 랭킹
- 메뉴 랭킹별 리뷰
- 점심 메뉴 추천 룰렛
- 룰렛 결과 메뉴 리뷰 확인
- 리뷰 작성
- 나만의 점심 달력 만들기

<br />

### 4. 기타

- 홈 화면 리디자인
- 마이 페이지 리디자인
- 포인트 지도
- 포인트 활용 (준비 중)

<br />

| 홈 리디자인 | 마이페이지 리디자인 |
| :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: |
| <img src="https://github.com/livable-final/client/assets/116873887/560c0002-5666-4c56-aa8a-c3c499a07824" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/63b59842-29fb-4ccd-bc16-7e46d467c69e" width="250" /> |
| 방문자 초대장 생성 | 방문자 초대장 뷰 |
| <img src="https://github.com/livable-final/client/assets/116873887/337c7119-7342-47e2-8148-3f573b79de2b" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/7a295327-80ad-4137-a9ab-c28c8746d99a" width="250" /> |
| 초대장 리스트 | 빌딩 정보 |
| <img src="https://github.com/livable-final/client/assets/116873887/eecf4b91-6c37-4f2e-94e7-42d5503a3a6a" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/6cb79048-5b48-44b8-9179-96b95662aeb9" width="250" /> |
| 초대 장소 확인 | 주차 등록 |
| <img src="https://github.com/livable-final/client/assets/116873887/a4538ff5-ed3b-4219-91f1-8c598576aadc" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/cdf1ad37-924f-42f1-bc41-25d039ba83e3" width="250" /> |
| 오늘 점심 룰렛 | 오늘 점심 메인 |
| <img src="https://github.com/livable-final/client/assets/116873887/4afee3d4-902c-46f7-b027-5661bcef5dd0" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/4c756265-c7fb-462b-bc7a-d424a771e852" width="250" /> |
| 오늘 점심 리뷰 작성 | 오늘 점심 리뷰 작성 |
| <img src="https://github.com/livable-final/client/assets/116873887/b5529fb2-1fc0-487b-99d3-c2e2c2a218d0" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/9ad4c2c7-feb2-420c-b638-759275431f4d" width="250" /> |
| 오늘 점심 달력 | 오늘 점심 랭킹별 리뷰 |
| <img src="https://github.com/livable-final/client/assets/116873887/19a17c11-ca08-4262-9875-b781b4a0e48a" width="250" /> | <img src="https://github.com/livable-final/client/assets/116873887/ebe37978-aa71-44aa-8db2-7023e8998ff2" width="250" /> |

<br></br>

## 💻 프로젝트 테스트

### clone project

```bash
$ [email protected]:livable-final/client.git
$ [email protected]:livable-final/admin.git
```

### go to project

```bash
$ cd client
$ cd admin
```

### install npm

```bash
$ npm install
```

### start project

```bash
$ npm run dev
```

<br />

1 comment on commit 4a8f1ab

@vercel
Copy link

@vercel vercel bot commented on 4a8f1ab Oct 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

client-rosg – ./

officener.vercel.app
client-rosg-git-dev-six-sense2.vercel.app
client-rosg-six-sense2.vercel.app

Please sign in to comment.