Skip to content

Commit

Permalink
Update README.md (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
@judahhh
judahhh authored Dec 14, 2023
1 parent 7b176c7 commit 254843e
Showing 1 changed file with 85 additions and 23 deletions.
108 changes: 85 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,93 @@
# React + TypeScript + Vite
<div style="display: flex; align-items: flex-start;">
<div style="margin-top: 35px;">
<img src="https://github.com/coffee-meet/frontend/assets/96521594/9f6c918b-a27e-4776-bd00-62f8880b6bda" width="100" height="100">
</div>
<div style="margin-left: 20px;">
<h1>☕️ Coffee-Meet</h1>
<h4>회사 내 랜덤 커피챗 매칭 서비스</h4>
</div>
</div>
<br>

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## 📣 개요
> **회사 내 활발한 네트워킹을 촉진시키는 실시간 랜덤 매칭 서비스입니다.**
> 💬 실시간 매칭 후 채팅을 통해 온/오프라인 만남 제공
> 💬 같은 회사 내 타 부서와의 교류를 통한 친목, 인사이트 제공 및 스트레스 해소
Currently, two official plugins are available:
![image](https://github.com/coffee-meet/frontend/assets/96521594/58123888-78c3-4e69-b863-1da27e66e9b0)

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md)
uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast
Refresh

## Expanding the ESLint configuration
<br><br>
--
### ▫️ 인증
![image](https://github.com/coffee-meet/frontend/assets/96521594/381530db-bed0-46d6-bab4-9170c15e0839)
<br>
--
### ▫️ 매칭
![image](https://github.com/coffee-meet/frontend/assets/96521594/bb01bf33-2a5d-41c8-9f1d-b25970bd0a93)
<br>
--
### ▫️ 채팅
![image](https://github.com/coffee-meet/frontend/assets/96521594/fcce0b4e-8afb-447b-afbe-f218a4191392)

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
<br><br>

- Configure the top-level `parserOptions` property like this:
## 👨‍👩‍👧‍👦 Developers

```js
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
```
| Frontend | Frontend |
|:-----------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------:|
| <img src="https://avatars.githubusercontent.com/u/96521594?s=300&v=4" width="130" height="130"> | <img src ="https://avatars.githubusercontent.com/u/69716992?v=4" width="130" height="130"> |
| [주다현](https://github.com/judahhh) | [홍창기](https://github.com/cheshier)


<br><br>

## 💻 Tech Stack
![image](https://github.com/coffee-meet/frontend/assets/96521594/f8b0017a-80ee-4675-8cd1-4319439d86f9)


- Backend
<img src="https://img.shields.io/badge/Java 17-007396?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Spring Boot 3-6DB33F?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Gradle-02303A?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Json Web Token-000000?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Junit5-25A162?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/MySQL-4479A1?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Redis-DC382D?style=flat&logoColor=white"><br>
<img src="https://img.shields.io/badge/EC2-FF9900?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/S3-569A31?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Docker-2496ED?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Nginx-009639?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Firebase-FFCA28?style=flat&logoColor=white">
<br>
- Frontend
<img src="https://img.shields.io/badge/Typescript-3178C6?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/React-61DAFB?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/React Router-CA4245?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/React Hook Form-EC5990?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Axios-5A29E4?style=flat&logoColor=white">
<br>
- Etc
<img src="https://img.shields.io/badge/Slack-4A154B?style=flat&logoColor=white">
<img src="https://img.shields.io/badge/Notion-000000?style=flat&logoColor=white">

<br><br>

## 🔩 시연 영상

| **푸시 알림** | **매칭 & 채팅** | **매칭 & 채팅** | **프로필 조회** |
|:-------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------:|:----------:|:----------:|
|![KakaoTalk_Photo_2023-12-05-01-33-48](https://github.com/coffee-meet/frontend/assets/96521594/b23922d2-eb62-4599-ab7b-4db066d34fa1)|![KakaoTalk_Photo_2023-12-05-01-33-36](https://github.com/coffee-meet/frontend/assets/96521594/8d46cdc3-3456-4518-bcdc-5fb116334c98)|![ezgif com-video-to-gif](https://github.com/coffee-meet/frontend/assets/96521594/ee77ac3f-a993-4f88-ac83-e4c1a960dbf1)|![KakaoTalk_Photo_2023-12-05-01-38-29](https://github.com/coffee-meet/frontend/assets/96521594/6ae8b848-f3fa-4043-878e-f73def6c8f4b)|
<br><br>




## 📲 User Flow
![image](https://github.com/coffee-meet/frontend/assets/96521594/be3698db-57a9-418d-8f9e-fabfaf4d7e6d)

<br>
## 🎶 Frontend CI/CD Flow

![image](https://github.com/coffee-meet/frontend/assets/96521594/6011aee1-40fc-4298-9421-bf02ea5ebf10)

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked`
or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and
add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

0 comments on commit 254843e

Please sign in to comment.