diff --git a/README.md b/README.md index cca7918..a6d7798 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,75 @@ # StudyFlex-BE -스터디 플렉스 백엔드팀입니다. \ No newline at end of file +## **📍**프로젝트 소개 + +> **팀 스터디를 통해 성장하고 싶은 당신🤚, +캠퍼스별 팀스터디 매칭 관리 웹 서비스 Study Flex에서 성장하세요!** +> +스크린샷 2024-06-26 오후 1 18 13 + + +--- + +## **📍사용 기술 스택** + +- 프레임워크: 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 + +--- + +## **📍아키텍처** +스크린샷 2024-06-26 오후 1 18 02 + +--- + +## **📍역할** + +시스템 아키텍처 설계 +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 명세 + 스크린샷 2024-06-26 오후 1 17 36 + + - ERDCloud : ERD 작성 + 스크린샷 2024-06-26 오후 1 17 26 + + +- **데이터베이스 관리**: DataGrip +- **API Test:** Postman +- **기타 도구**: Google Meet (협업 및 실시간 피드백 도구)