README.md

🪨 2024-2-SCS4031-PocketStone-6

🧑‍💼 사내 데이터를 이용한 프로젝트 팀빌딩 시스템 [ Team-Sync ]

2024년 2학기 융합캡스톤디자인 6조 돌주머니
gunheee-leee	Minbro-Kim	BrianKim913	MinSungJe
이건희	김민형	김범수	성민제
Team Leader, Model	Backend	Backend	Frontend

💿 프로젝트 실행 방법

1. 프로젝트 clone 받기

git clone https://github.com/CSID-DGU/2024-2-SCS4031-PocketStone-6.git

2. backend/team-sync 👉 데이터 베이스 주소 변경

• backend\team-sync\src\main\resources\application.properties
  • spring.datasource.url, spring.datasource.username, spring.datasource.password 수정
  • 수정 내용은 이메일 참조(데이터베이스 주소)

3. backend/team-model 👉 .env 파일 추가

• backend\team-model\app\에 .env 파일 추가
  • 내용은 이메일 참조(OPENAPI KEY)

4. backend/team-model 👉 데이터 베이스 주소 변경

• backend\team-model\app\database.py
  • DATABASE_URL, SCALED_DATABASE_URL 수정
  • 수정 내용은 이메일 참조(데이터베이스 주소)

5. backend 파일 실행

• 모델 서버 실행

  (메인 폴더 위치에서)
  cd backend/team-model/app
  pip install uvicorn sqlalchemy==1.4.39 pymysql==1.1.0 fastapi
  uvicorn main:app --reload

• SPRINGBOOT 서버 실행

  (메인 폴더 위치에서)
  cd backend/team-sync
  ./gradlew clean build
  cd build/libs
  java -jar team-sync-0.0.1-SNAPSHOT.jar

6. frontend 👉 .env 파일 추가

• frontend\에 .env 파일 추가
  • 내용: REACT_APP_API_URL=http://localhost:8080

7. frontend 파일 실행

(메인 폴더 위치에서)
cd frontend
npm install
npm start

8. 로그인 계정

• ID: pocketstone
• PW: pocket123

🔎 살펴보기

🖥️ (필요시)서버 주소 세부조정

• WebClientConfig.java
  • baseUrl()을 해당 fastapi 서버로 수정
• WebSecurityConfig.java
  • 61번째줄 코드(configuration.setAllowedOrigins(Arrays.asList)를 리액트 주소로 수정

🎯 Commit Convention

• 구성

  {역할}: [{키워드}] {내용}
  

  • 역할 - Model, BE, FE
  • 예시 - FE: [feat] 회원가입 페이지 구성

• 키워드

  키워드	내용
  feat	새로운 기능 추가
  fix	버그 수정
  docs	문서 수정
  style	코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우
  refactor	코드 리펙토링
  test	테스트 코드, 리펙토링 테스트 코드 추가
  chore	빌드 업무 수정, 패키지 매니저 수정(npm, .gitignore 등)
  remove	파일 삭제
  rename	파일 이름 변경