Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(root, member): update README.md #177

Merged
merged 2 commits into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,28 @@

> 해당 모노레포에 포함된 모든 프로젝트는 다음과 같은 특징을 가지고 있어요.

- 지속적이고 원활한 인수인계를 위해 간단한 코드라도 `주석`을 작성해요.
- 지속가능한 개발과 원활한 인수인계를 위해 간단한 코드라도 `주석`을 작성해요.
- 최신 기술만을 고집하지 않고 문제 해결에 필요한 `최적의 기술을 선정`하여 사용해요.
- 모든 시스템은 도입과 사용이 편리하도록 `설정(Config)`과 `API`를 제공해요.
- 모든 디자인은 `Mobile First Design` 원칙에 따라 제작되었어요.
- 일관된 사용자 경험을 제공하기 위해 자체 개발한 `design-system`을 사용하고 있어요.
- 일관된 사용자 경험을 제공하기 위해 자체 개발한 `Design System`을 사용하고 있어요.

## Apps

![clab-page-apps](https://github.com/KGU-C-Lab/clab.page/assets/39869096/53aa46ab-4a45-4dab-a9c4-45ea72b48d76)

> 시스템에 더 자세히 알고 싶다면 시스템 `README.md`를 살펴봐주세요.
> 프로젝트 구성도에요. 시스템에 더 자세히 알고 싶다면 시스템 `README.md`를 살펴봐주세요.

- [auth](/apps/auth/README.md): 동아리 계정을 OAuth 프로토콜을 기반으로 서비스에 편리하게 연결할 수 있는 통합 인증 시스템이에요.
- [land](/apps/land/README.md): 동아리에 대한 소개, 활동, 블로그 등 다양한 정보를 공유하는 랜딩페이지 시스템이에요.
- [member](/apps/member/README.md): 동아리원의 활동과 커뮤니케이션을 지원하는 그룹웨어 시스템이에요.
- [time](/apps/time/README.md): 학교의 공지사항이나 축제 정보와 시간표, 학점 관리 등 학교 생활에 필요한 것을 관리하는 플랫폼 시스템이에요.
- auth: 구성원 계정을 OAuth 프로토콜을 기반으로 서비스에 편리하게 연결할 수 있는 통합 인증 시스템이에요.
- land: 모임에 대한 소개, 활동, 블로그 등 다양한 정보를 공유하는 랜딩페이지 시스템이에요.
- [member](https://github.com/KGU-C-Lab/clab.page/blob/main/apps/member/README.md): 구성원의 활동과 커뮤니케이션을 지원하는 인터널(Internal) 그룹웨어 시스템이에요.
- time: 학교의 공지사항이나 축제 정보와 시간표, 학점 관리 등 학교 생활에 필요한 것을 관리하는 플랫폼 시스템이에요.

## Packages

- [config](/packages/config/README.md): 프로젝트 설정 파일의 일관성을 유지하기 위한 라이브러리에요.
- [design-system](/packages/design-system/README.md): 일관성 있는 UI&UX를 위한 디자인 시스템이에요.
- [utils](/packages/utils/README.md): 공통적으로 사용하는 유틸리티 라이브러리에요.
- [hooks](/packages/hooks/README.md): 공통적으로 사용하는 React Hooks 라이브러리에요.
- [icon](/packages/icon/README.md): 공통적으로 사용하는 아이콘팩이에요.
- config: 프로젝트 설정 파일의 일관성을 유지하기 위한 라이브러리에요.
- [design-system](https://github.com/KGU-C-Lab/clab.page/blob/main/packages/design-system/README.md): 일관성 있는 UI&UX를 위한 디자인 시스템이에요.
- utils: 공통적으로 사용하는 유틸리티 라이브러리에요.
- icon: 공통적으로 사용하는 아이콘팩이에요.

## Previews

Expand All @@ -46,10 +44,10 @@
</tr>
<tr>
<td width="50%" style="padding: 0;">
<img width="518" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/5370ff52-f190-4151-990c-96681a211425">
<img width="518" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/7a6b171f-a4d8-43f3-88b7-4c7bbc37280e">
</td>
<td width="50%" style="padding: 0;">
<img width="1494" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/1a983b65-caee-4ae0-9bcd-d3e9174fdeb9">
<img width="1494" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/8f7db319-8f0c-454e-82cb-decdd30785d7">
</td>
</tr>
<tr>
Expand All @@ -58,7 +56,7 @@
</tr>
<tr>
<td width="50%" style="padding: 0;">
<img width="1488" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/0555fda3-05b3-4637-bb4f-76936454c89d">
<img width="1488" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/d4e5b561-74a2-4bdc-b306-48aba58e3c5a">
</td>
<td width="50%" style="padding: 0;">
<img width="1263" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/62d7af18-8f6e-4e0f-aac6-2d5199842c9c">
Expand All @@ -76,7 +74,7 @@

동아리원이 아니더라도 누구나 기여할 수 있습니다. 해당 프로젝트에 기여하고 싶다면 아래 문서를 참고해주세요.

[CONTRIBUTING.md](CONTRIBUTING.md)
[CONTRIBUTING.md](https://github.com/KGU-C-Lab/clab.page/blob/main/CONTRIBUTING.md)

## FAQs

Expand All @@ -97,7 +95,7 @@

## License

C-Lab의 모든 공개 프로젝트는 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)의 라이선스를 따라요.
C-Lab의 모든 공개 프로젝트는 [GNU General Public License v3.0](https://github.com/KGU-C-Lab/clab.page/blob/main/LICENSE)의 라이선스를 따라요.
자세한 사항은 `LICENSE`를 참고해주세요.

**© Kyonggi University C-Lab**
93 changes: 82 additions & 11 deletions apps/member/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,97 @@
# Member
# Member &middot; [![MIT License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](https://github.com/kgu-c-lab/clab.page/blob/main/LICENSE) [![pnpm CI](https://github.com/KGU-C-Lab/clab.page/actions/workflows/pnpm-ci.yml/badge.svg)](https://github.com/KGU-C-Lab/clab.page/actions/workflows/pnpm-ci.yml)

C-Lab의 공식 활동 플랫폼이에요. C-Lab의 모든 활동은 이곳에서 이루어져요.
멤버스(Member) 프로젝트는 구성원의 활동과 커뮤니케이션을 지원하는 인터널(Internal) 그룹웨어 시스템이에요.
모임에서 필요한 모든 기능을 제공하며, 구성원들이 손쉽게 활동을 관리하고 소통할 수 있도록 도와줘요. 활동, 일정, 커뮤니티, 도서관, 회비 등 다양한 기능을 제공하고 있어요.

C-Lab의 공식 인터널 플랫폼이에요. 동아리의 모든 활동은 이곳에서 이루어져요.

- DAU 60+명, 리텐션 99%의 인터널 그룹웨어 플랫폼이에요.
- 매 학기 활동하는 구성원 약 50명과 졸업생 약 10명, 총 60명이 사용하고 있어요. 사용자는 지속적으로 늘고있어요.

## Features

- 동아리 일정을 확인할 수 있어요.
- 동아리 활동 그룹을 개설하고 참여할 수 있어요.
- 다양한 커뮤니티를 통해 동아리원들과 소통할 수 있어요.
- 회비 시스템을 통해서 회비 사용을 신청할 수 있어요.
### 일정

다양한 모임 일정을 확인하고 관리할 수 있어요. 일정을 추가하고 수정할 수 있으며, 일정에 대한 상세한 정보를 확인할 수 있어요. 모임의 일정뿐만 아니라 활동 그룹 일정도 관리할 수 있어요.

### 활동

스터디, 프로젝트 등 다양한 활동 그룹을 자유롭게 개설하고 참여할 수 있어요. 각 활동에 대한 상세한 정보를 확인할 수 있어 새로운 활동을 찾고 참여하기 좋아요. 또한 활동에 대한 로그를 남길 수 있어 진행 상황을 체계적으로 관리할 수 있어요.

### 커뮤니티

커뮤니티 기능을 통해 다양한 소식을 확인하고 소통할 수 있어요. 중요한 공지사항을 쉽게 확인할 수 있으며, 모임 내 중요한 소식이나 업데이트를 빠르게 전달할 수 있어요. 자유롭게 의견을 나누고 소통할 수 있는 자유게시판과 질문과 답변을 통해 지식을 공유할 수 있는 Q&A 게시판도 제공하고 있어요.

### 도서관

도서관 기능을 통해 도서를 대여하고 반납할 수 있으며, 모임이 소유한 도서 목록을 효율적으로 관리할 수 있어요. 모든 대여 및 반납 기록을 투명하게 공개하여 신뢰성을 높이고, 각 도서의 상태를 실시간으로 확인할 수 있어요.

### 회비

회비 관리 기능을 통해 회비를 체계적으로 관리할 수 있어요. 회비 승인 및 결제를 통해 회비를 더욱 쉽게 관리할 수 있으며, 회비 사용 내역은 투명하게 공개되어 확인할 수 있어요.

## Tech Stack

| 구분 | 스킬 |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Core | ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6.svg?style=flat-square&logo=TypeScript&logoColor=white) ![React](https://img.shields.io/badge/React-61DAFB?style=flat-square&logo=React&logoColor=black) |
| State Management | ![Recoil](https://img.shields.io/badge/Recoil-3578E5?style=flat-square&logo=recoil&logoColor=white) |
| Data Fetching | ![React Query](https://img.shields.io/badge/React_Query-FF4154?style=flat-square&logo=ReactQuery&logoColor=white) |
| Styling | ![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-06B6D4?style=flat-square&logo=TailwindCSS&logoColor=white) |
| Package Manager | ![pnpm](https://img.shields.io/badge/pnpm-F69220?style=flat-square&logo=pnpm&logoColor=white) |
| Test | ![vitest](https://img.shields.io/badge/vitest-6E9F18.svg?style=flat-square&logo=vitest&logoColor=white) |
| CI&CD | ![GitHub](https://img.shields.io/badge/Github-%23121011.svg?style=flat-square&logo=github&logoColor=white) ![Jenkins](https://img.shields.io/badge/Jenkins-D24939.svg?style=flat-square&logo=Jenkins&logoColor=white) |

## Preview

<img width="1263" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/75af3c12-d815-4b3e-a275-a12024525f5d">
<table>
<tr>
<td width="50%">홈</td>
<td width="50%">일정</td>
</tr>
<tr>
<td width="50%" style="padding: 0;">
<img width="518" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/d4e5b561-74a2-4bdc-b306-48aba58e3c5a">
</td>
<td width="50%" style="padding: 0;">
<img width="1494" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/38f6c917-ce46-4548-ad30-7a591b59d20b">
</td>
</tr>
<tr>
<td width="50%">커뮤니티</td>
<td width="50%">도서관</td>
</tr>
<tr>
<td width="50%" style="padding: 0;">
<img width="1488" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/7d96d285-4b6a-4ba3-bf35-aaaba9a73130">
</td>
<td width="50%" style="padding: 0;">
<img width="1263" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/d96e61e7-b6e9-40cd-aab2-4ffaeb43c947">
</td>
</tr>
<tr>
<td width="50%">회비</td>
<td width="50%">마이페이지</td>
</tr>
<tr>
<td width="50%" style="padding: 0;">
<img width="1488" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/1c466eca-7c76-43b2-a1fa-d240156a3e73">
</td>
<td width="50%" style="padding: 0;">
<img width="1263" alt="image" src="https://github.com/KGU-C-Lab/clab.page/assets/39869096/1c26f29a-1ba7-4408-9b93-df0330bdad28">
</td>
</tr>
</table>

## Contributing

동아리원이 아니더라도 누구나 기여할 수 있습니다. 해당 프로젝트에 기여하고 싶다면 아래 문서를 참고해주세요.
[CONTRIBUTING.md](../../CONTRIBUTING.md)
동아리원이 아니더라도 누구나 기여할 수 있습니다. 해당 프로젝트에 기여하고 싶다면 아래 문서를 참고해주세요.

[CONTRIBUTING.md](https://github.com/KGU-C-Lab/clab.page/blob/main/CONTRIBUTING.md)

## License

C-Lab의 모든 공개 프로젝트는 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)의 라이선스를 따라요.
자세한 사항은 `LICENSE`를 참고하세요.
C-Lab의 모든 공개 프로젝트는 [GNU General Public License v3.0](https://github.com/KGU-C-Lab/clab.page/blob/main/LICENSE)의 라이선스를 따라요.
자세한 사항은 `LICENSE`를 참고해주세요.

**© Kyonggi University C-Lab**