👋 Likelion-To-Star GitHub Organization 👋

Likelion-To-Star는 펫로스로 인한 상실감을 치유하고 소중한 추억을 되새길 수 있는 따뜻한 서비스입니다.

I. 팀원 소개 (Team Members) 👥

고희주(BE)	김보미(PM)	김혜진(BE)	장서원(FE)	최강(BE)	최윤영(FE)
@HeejuKo	@bomi03	@khyaejin	@oculo0204	@y2hscmtk	@chldsbdud

II. 🐾 프로젝트 소개 (About Project) 🐾

별이에게는 펫로스 증후군을 겪는 사람들을 위한 따뜻한 공간을 제공합니다. 반려동물의 상실로 인한 아픔을 치유하고 추억을 되새길 수 있도록 돕습니다.

1. 펫로스 커뮤니티💬 :
   반려동물을 잃은 사람들이 모여 소통하고 위로받을 수 있는 공간입니다. 실시간 소켓 기능을 통해 감정을 나누고 공감할 수 있습니다.

2. 편지 쓰기 및 답장 기능💌 :
   떠나보낸 반려동물에게 편지를 쓰고, AI가 생성한 답장을 받는 기능입니다. 이를 통해 마음을 정리하고 추억을 되새길 수 있습니다.

3. 게시물 등록 및 친구 추가🐶 :
   사용자가 서로의 게시물을 공유하고 친구를 추가하며 더 깊은 교류를 할 수 있습니다.

III. 📚 기술 스택 (Tech Stack) 📚

• 💻 Java와 Spring Boot: 강력한 백엔드 서비스 구축
• 🌐 React: 사용자 친화적인 프론트엔드 인터페이스 개발
• 🗄️ MySQL: 효율적인 데이터베이스 관리
• ☁️ AWS: 클라우드 배포 및 관리
• 🚀 CI/CD: Docker와 GitHub Actions를 활용한 자동 빌드 및 배포
• 🔄 Git Workflow: 백엔드는 dev 브랜치를 기준으로 작업하며, 각 기능이나 버그 수정을 위해 이슈 번호를 포함한 브랜치를 생성하여 진행합니다. 완료된 작업은 dev로 PR을 생성하고, GitHub Actions가 자동으로 코드를 빌드하고 테스트합니다. 모든 테스트를 통과하면, dev에 머지되고 자동으로 재배포가 이루어집니다.

IV. 프로젝트 구조 (Project Structure) 🗂️

• To-star-Frontend: 사용자 상호작용 처리 (Frontend Interaction)
• To-star-Backend: API 및 데이터 흐름 관리 (API & Data Management)

V. ERD 및 구조도 (ERD and Architecture) 📊

1. ERD

2. 시스템 구조도 (System Architecture)

3. 기능 구조도 (Function Architecture)

VI. 시작 가이드 (Getting Started) 🚀

1. 레포지토리 복제 (Clone the Repository)

   • Frontend:
     git clone https://github.com/HSU-NIMBUS2000/Pyeoning-Frontend.git
   • Backend:
     git clone https://github.com/HSU-NIMBUS2000/Pyeoning-Backend.git

2. 프로젝트 디렉토리로 이동 (Navigate to the Project Directory)
   cd <repository-name>

3. **환경변수 설정(.env 파일 설정) ** REACT_APP_API_BASE_URL= 서버주소

4. 의존성 설치 (Install Dependencies) (Frontend)
   npm install

5. 빌드 및 실행 (Build and Run)

   • Frontend:
     npm start
   • Backend:
     ./gradlew bootRun

VII. 프로젝트 상세 소개

해당 프로젝트는 펫로스 증후군 치유하기 위해 전문가들이 제시하는 3가지 단계(반려동물과 행복했던 추억을 상기, 자신의 감정을 솔직하게 표현, 편지나 글로 마음을 전달)에 따라 회고글쓰기 게시판, 실시간 채팅, 편지쓰기 3가지 주요 페이지를 기획, 개발하였습니다.

프론트 배포 링크 : fe-tostar.vercel.app (서버 유효기간 종료로 기능하지 않을 수 있음)

2024-11-18_15_42_48_video.1.1.1.mp4

-메인페이지/로그인,회원가입

-친구들과

-커뮤니티 -별이에게

VIII.⭐ README 소개 (About this README) ⭐

이 README는 Likelion-To-Star 프로젝트의 기술 스택, 구조, 시작 가이드를 간결하고 명확하게 설명합니다.

✨ Special Thanks ✨
Thanks to the PND team for their continuous support! 🚀
For more details, check out the GitHub repository.