Skip to content

Commit

Permalink
[docs] : 기본 README.md 구성 (#130)
Browse files Browse the repository at this point in the history
* docs: 기본 README 추가

* docs: update README.md

reformat tech stack table
  • Loading branch information
jbw9964 authored Jan 4, 2025
1 parent 27d7a4d commit 30b6acb
Show file tree
Hide file tree
Showing 13 changed files with 149 additions and 0 deletions.
149 changes: 149 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
# 🙋‍♀️ Palettee 를 소개합니다!

**Palettee** 는 다양한 업종의 취준생, 협업 재사자의 자기계발을 위한 플랫폼입니다.

<!-- palettee-portfolio-view.png -->

<p align="center">
<img src="./assets/images/palettee-portfolio-view.png" width="80%" height="80%">
</p>

| 자신이 작성한 `Archive` 목록 | 자신이 작성한 `프로젝트, 스터디 구인글` 목록 |
|:---------------------------------------------------------------:|:-------------------------------------------------------------------:|
| ![user-archive](./assets/images/palettee-user-archive-view.png) | ![user-gathering](./assets/images/palettee-user-gathering-view.png) |

---

## 🚀 **Palettee** 는 다음 기능들을 제공합니다!

<details><summary> ✅ 간편한 소셜 로그인</summary>

> **Palettee** 는 Google 소셜 로그인을 지원합니다.
>
> <!-- examples/login-example.png -->
>
> <p align="center">
> <img src="assets/images/examples/login-example.png" width="80%" height="80%">
> </p>
>
> 비밀번호를 외울 필요 없이 간편히 로그인하세요!
</details>

<details><summary> 🔥 실시간 인기 포트폴리오</summary>

> 현재 사용자들이 많이 조회하는 포트폴리오를 보여줍니다.
>
> <!-- examples/popular-portfolio-example.png -->
>
> <p align="center">
> <img src="assets/images/examples/popular-portfolio-example.png" width="80%" height="80%">
> </p>
>
> 포트폴리오를 게시해서 인기 포트폴리오를 노려보세요!
</details>

<details><summary> 💻 프로젝트 • 스터디 등 자기계발 팀원 모집</summary>

> **Palettee** 를 통해 소중한 팀원을 구해보세요!
>
> | ![gathering-example-1](./assets/images/examples/gathering-example-1.png) | ![gathering-example-2](./assets/images/examples/gathering-example-2.png) |
> |:------------------------------------------------------------------------:|:------------------------------------------------------------------------:|
>
> **Palettee**`게더링` 게시판을 통해 프로젝트, 스터디, 동아리 등 손쉽게 팀원을 구할 수 있습니다.
</details>

<details><summary> 💬 사용자간 자유로운 채팅</summary>

> **Palettee** 는 사용자간 채팅을 지원합니다!
>
> <!-- examples/chatting-example.png -->
>
> <p align="center">
> <img src="assets/images/examples/chatting-example.png" width="80%" height="80%">
> </p>
>
> `포트폴리오 첨삭 요청`, `프로젝트 구인 요청` 등 활발한 네트워킹을 시작해 보세요!
</details>

<details><summary> 🥰 실시간 좋아요 알림</summary>

> **Palettee** 는 사용자에게 실시간 알림을 제공합니다.
>
> | ![alarm-example-1](./assets/images/examples/alarm-example-1.gif) | ![alarm-example-2](./assets/images/examples/alarm-example-2.png) |
> |:----------------------------------------------------------------:|:----------------------------------------------------------------:|
>
> 사용자에게 `채팅 요청` 이 들어오거나 게시글에 `좋아요` 가 달렸을 시 알림을 보내드립니다!
</details>

---

## 📑 Project 기술 스택

| 아키텍처 | 사용한 기술 |
|------------------------------------------------------------------------|------------------------------------------------------|
| ![backend-architecture](./assets/images/tech/backend-architecture.png) | ![tech-stacks](./assets/images/tech/tech-stacks.png) |

<details><summary> Stacks on Table</summary>

- Application

| Name | Description |
|:--------------------:|:----------------------------------------------:|
| Java | 사용 언어 |
| Gradle | 빌드 도구 |
| Spring Boot | 프로젝트 프레임웍 |
| Spring Security | 요청 인증 • 인가 & filtering request |
| Spring Validation | 요청 유효 검증 |
| Redis | Refresh token 저장, Data caching, 채팅 메시지 Pub/Sub |
| STOMP | 채팅 메시지 broker |
| Spring OAuth2 Client | 소셜 로그인 |
| JWT | 사용자 인증 • 인가 토큰 |
| Swagger | API 문서 공유 |

- Test

| Name | Description |
|:-----------:|:--------------------:|
| JUnit5 | 테스트 프레임웍 |
| H2 Database | 테스트용 In-memory DB |
| Jacoco | 테스트 코드 coverage 분석 |
| Sonar Cloud | 정적 코드 분석 |

- Infra & Monitoring

| Name | Description |
|:----------:|:--------------------------------------:|
| Nginx | Load balancing & Blue/Green deployment |
| Prometheus | Collecting server status metrics |
| Grafana | Visualizing server status metrics |
| AWS EC2 | Remote deployment |
| AWS RDS | Deployment DB |
| AWS S3 | Image storage |

- Persistence

| Name | Description |
|:---------------:|:---------------------------------:|
| MySQL | RDBMS |
| Spring Data JPA | JPA based persistence abstraction |
| QueryDSL | Supports dynamic query for JPA |

- CI/CD & Cooperation

| Name | Description |
|:-------------:|:-------------------:|
| Docker | 컨테이너화를 통한 자동 배포에 사용 |
| Github Action | CI/CD 사용 |
| Slack | 협업 & 배포 서버 모니터링 |
| Git | 협업 툴 |

</details>

---


Binary file added assets/images/examples/alarm-example-1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/examples/alarm-example-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/examples/chatting-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/examples/gathering-example-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/examples/gathering-example-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/examples/login-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/palettee-portfolio-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/palettee-user-archive-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/palettee-user-gathering-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/tech/backend-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/tech/tech-stacks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 30b6acb

Please sign in to comment.