Skip to content

Commit

Permalink
[docs/#167] README 추가 작성
Browse files Browse the repository at this point in the history
  • Loading branch information
whitem4rk committed Sep 17, 2024
1 parent 8918e9e commit b3a72bf
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,13 @@ IBAS 공식 웹페이지는 인하대학교 빅데이터 학술 동아리의 활

[2023.09~2024.07 웹서비스 개발 문서](https://www.notion.so/IBAS-049505480e5f4bebbb01bfc9b1e9c3c0)

<br/>

## Architecture
![Architecture](docs/images/architecture.png)

<br/>

## Stacks
### Language & Framework
![Java](https://img.shields.io/badge/Java-ED8B00?style=for-the-badge&logo=openjdk&logoColor=white) ![Spring Boot](https://img.shields.io/badge/SpringBoot-6DB33F?style=for-the-badge&logo=Spring&logoColor=white) ![Spring Dada JPA](https://img.shields.io/badge/Spring_data_jpa-6DB33F?style=for-the-badge&logo=Spring&logoColor=white) ![Spring Security](https://img.shields.io/badge/Spring%20Security-6DB33F?style=for-the-badge&logo=springsecurity&logoColor=white) ![Spring Boot](https://img.shields.io/badge/Spring%20Cloud%20config-6DB33F?style=for-the-badge&logo=spring&logoColor=white) ![Querydsl](https://img.shields.io/badge/Querydsl-003366?style=for-the-badge&logo=Querydsl&logoColor=white)
Expand All @@ -44,13 +48,15 @@ IBAS 공식 웹페이지는 인하대학교 빅데이터 학술 동아리의 활
### Documentation
![Swagger](https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=white)

<br/>

## Style Convention

IBAS Project는 코드 품질과 가독성을 유지하기 위해 일관된 스타일 규약을 따르고 있습니다. 기여하기 전 아래 문서를 참고해주세요.

[STYLE-CONVENTION.md](STYLE-CONVENTION.md)

<br/>

## Main Features

Expand All @@ -60,12 +66,16 @@ IBAS Project는 코드 품질과 가독성을 유지하기 위해 일관된 스
- 자세한 Request, Response 예시 제공
- Token 인증 방식을 활용한 권한 테스트 지원

<br/>

### 회원관리
![Manage-users](docs/images/show/manage-user.gif)
- 권한별 제한된 회원 등급 관리
- 신입 부원 가입 관리
- 권한별 개인정보 마스킹 처리

<br/>

![Board](docs/images/show/board.gif)
- 권한별, 게시판별 CRUD
- 검색 기능
Expand All @@ -78,6 +88,8 @@ IBAS Project는 코드 품질과 가독성을 유지하기 위해 일관된 스
- 복수 파일 추가, 삭제 기능
- 다운로드 기능

<br/>

![Comment](docs/images/show/comment.gif)
- 권한별 CRUD
- 대댓글 기능
Expand All @@ -86,13 +98,17 @@ IBAS Project는 코드 품질과 가독성을 유지하기 위해 일관된 스
- 해당 댓글이 대댓글을 포함한 경우 `삭제된 댓글입니다.` 표시로 대체
- 해당 댓글이 말단 댓글인 경우만 삭제

<br/>

![Account](docs/images/show/account.gif)
- 총무만 CRUD 허용
- 단, 이전 기수 총무가 작성한 것은 수정 불가
- 총무가 직접 사용하지 않아 송금을 하는 경우, 예산지원 신청 심사를 거쳐 자동 기록
- 트랜잭션 관리로 동시성 제어
- 잔액 자동 계산 기능

<br/>

### 그 외 여러가지 기능
- OAuth2 로그인
- 동아리 정책 관리
Expand All @@ -102,6 +118,8 @@ IBAS Project는 코드 품질과 가독성을 유지하기 위해 일관된 스
- 동아리 연혁
- 공모전, 장학회 등 여러 형태의 게시판

<br/>


## Problem documentation

Expand All @@ -119,6 +137,7 @@ IBAS Project는 코드 품질과 가독성을 유지하기 위해 일관된 스
- forked repository PR에서 pull_request시 secrets값을 가져오지 못하는 오류
- JPA 성능 최적화

<br/>

## How to contribute to IBAS

Expand All @@ -134,6 +153,8 @@ IBAS에 소속된 회원이라면 누구든지 이 프로젝트에 기여할 수

[COMMITER-INSTRUCTION.md](COMMITER-INSTRUCTION.md)

<br/>

## Contributor Wall of Fame

[![IBAS back end contributors](https://contrib.rocks/image?repo=InhaBas/Inhabas.com-api)](https://github.com/InhaBas/Inhabas.com-api/graphs/contributors)

0 comments on commit b3a72bf

Please sign in to comment.