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

Update README.md #51

Closed
wants to merge 1 commit into from
Closed
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
75 changes: 74 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,75 @@
# StudyFlex-BE
스터디 플렉스 백엔드팀입니다.
## **📍**프로젝트 소개

> **팀 스터디를 통해 성장하고 싶은 당신🤚,
캠퍼스별 팀스터디 매칭 관리 웹 서비스 Study Flex에서 성장하세요!**
>
<img width="881" alt="스크린샷 2024-06-26 오후 1 18 13" src="https://github.com/StudyFlexUMC5th/StudyFlex-BE/assets/95922668/4b3b0c15-581a-4182-9c94-95ccab756c50">


---

## **📍사용 기술 스택**

- 프레임워크: Spring Boot
- 언어: Java 17
- 데이터베이스: MySQL, H2 (runtime only)
- 보안: Spring Security, JWT
- API 클라이언트: Spring Web
- 유효성 검사: Hibernate Validator
- 문서화: Swagger (springdoc-openapi)
- 이메일 서비스: Spring Boot Starter Mail
- 클라우드 서비스: AWS S3
- 특화 기능: Univcert (school web mail verification)
- 빌드 도구: Gradle

---

## **📍아키텍처**
<img width="571" alt="스크린샷 2024-06-26 오후 1 18 02" src="https://github.com/StudyFlexUMC5th/StudyFlex-BE/assets/95922668/610ac558-f066-430b-8e83-869d0e345136">

---

## **📍역할**

시스템 아키텍처 설계
API 명세 및 설계, DB 테이블 설계
서버와 DB 배포
CI/CD 구현
API 구현
- 소셜로그인
- 유저 관련 API 구현
- 웹메일 인증 관련 API 구현
- 신고하기 API 구현
- 공지 관련 API 구현
- 문의 관련 API 구현
- 메인페이지 스터디 관련 API 구현
- 스터디 페이지 스터디 관련 API 구현
- 스터디 내 공지사항 관련 API 구현

---

## **📍개발 환경**

- 운영체제: Ubuntu 20.04
- IDE/에디터: IntelliJ IDEA
- 버전 관리: Git, GitHub
- 패키지 매니저: Maven Central
- 기타 도구: Lombok, H2 Database (for in-memory database testing), Jitpack (for additional dependencies)

---

## **📍협업 도구**

- **커뮤니케이션**: Slack
- **프로젝트 및 문서 관리**: Notion
- Notion : API 명세
<img width="505" alt="스크린샷 2024-06-26 오후 1 17 36" src="https://github.com/StudyFlexUMC5th/StudyFlex-BE/assets/95922668/55fe2b69-1482-46ab-8eca-c2b20db5ecab">

- ERDCloud : ERD 작성
<img width="569" alt="스크린샷 2024-06-26 오후 1 17 26" src="https://github.com/StudyFlexUMC5th/StudyFlex-BE/assets/95922668/f45af649-c275-44bc-b87f-3788d1acbb8e">


- **데이터베이스 관리**: DataGrip
- **API Test:** Postman
- **기타 도구**: Google Meet (협업 및 실시간 피드백 도구)
Loading