Post

Project tips

2024년 KDT 1차 프로젝트

Posted
By
21 min read
  • 프로젝트의 완성과 완벽은 불가능하다고 생각하고 시작하시길..

🌟프로젝트를 시작하기 앞서..🌟

  • 팀장 혹은 기술 리더가 미리 세팅해놓으면 편리하고 좋은 것들
    1. 깃허브 세팅들
    1. 필필필수!!!!!!!!! 깃허브 가입하기. https://velog.io/@noyohanx/GIT-Github-가입하기
    2. 필필수!!!!!!!!!!!!!! 깃 bash 다운받기 https://xangmin.tistory.com/102
      • 요 두가지!! 실패하는 사람이 굉장히 많으니 성공한 팀원분이 열심히 알려줍시다 (권장)
      • 아무래도 영어권 국가가 아니니 에러코드를 잘 안읽어보고 안된다고 하더라고요 🥲 차근차근 영어를 읽어봅시다
    3. 깃 풀리퀘 템플릿 : https://wecandev.tistory.com/150
    4. 이슈 템플릿 : https://velog.io/@sasha1107/깃허브-이슈-템플릿-생성하기
      1. 템플릿들 복제 해보세용

    점심 - 노션 확인

  1. 인적사항들 적기
    1. 사람들 이름(or 닉네임), 초대할 툴 들 정보(깃허브 피그마 등..)
    2. 구성 및 역할, 누가 리더하는지 누가 FE인지 BE인지 등등..
      • 나중에 진짜로 이름을 잊을 때가 있어요
  2. 팀 규칙
    1. 저는 보통 약속 며칠 전까지 파토낼 수 있는지 프로젝트 마감일은 언제로 할지를 정해놨습니다.
    2. 컨벤션 규칙도 중요해요 진짜루

⭐ 작업할 파일 깃허브 연동 확인 / 당겨오기 ⭐

  1. git init
  2. git remote add origin “깃허브 주소”
  3. git pull origin main

편한 명령어 git clone "깃허브 주소"

→ 자주 쓴 공지문입니당 해당 노션 페이지를 공유했어도 사람들은 글을 잘 안읽는 편이니 모두가 모인 장소에서 꼼꼼히 같이 읽어보는걸 강강강추합니다

1. 작업하는 도중 문제 혹은 평소 질문이 생겼을 때

  • 가능한 스스로 문제 해결을 해보려 끝까지 노력해 봅시다 !
  • 인터넷 검색이나 관련 문서, AI 같은 도구들을 활용하는 능력도 중요해요!

2. 질문을 해야 할 때

  • 열심히 찾아봤지만 답이 나오지 않을 때 ! 무작정 질문하기보다 본인이 찾아본 문서나 정보들을 공유하며 질문해 주세요.
  • 답변자는 질문자가 스스로 답을 찾아갈 수 있도록 유도해 주세요 ~!

읽으면 도움이 될 작업 순서 🧑‍💻

  • 👩‍💻
    1. 기능 명세서 open
    2. 본인이 작업할 status를 in progress로 변경
    3. 깃허브 git issue로 들어가 new issue 클릭
    4. feature 리퀘스트 기능 추가 issue템플 get start
    5. title에 당일 작업으로 추가될 기능 작성
    6. 내용 양식에 맞춰 작성 ( 작업 상세 내역 작성 시 기능 명세서 요구사항 참고 )
    7. summit new issue 클릭

    ⭐ 작업할 파일 깃허브 연동 확인 / 당겨오기 ⭐

    1. git init
    2. git remote add origin “깃허브 주소”

    3. git pull origin main

      작업이 끝난 후

    4. cmd 키고 (루트) cd
    5. git checkout -b 브랜치 이름
    6. git add .
    7. gitmoji -c
    8. 이모지 골라주기 (검색도 가능해요 ~)

    9. git push origin 브랜치명

    10. 깃허브 접속
    11. pull request 클릭
    12. new pull request 클릭
    13. title 작성
    14. 양식 보고 어떤 기능을 추가, 수정했는지 작성
    15. create pull request 클릭
    16. 잠시 뒤 나오는 보라색 버튼 클릭
    17. 좀 기다리면 회색 버튼(delete branch) 클릭 끝🙌

🌟문서 확인🌟

혹 습관 들이기 어려운 분들은 밑의 리스트를 매일 반복적으로 해보시면 도움이 될 거에용

  1. 아침 - 깃 확인
    • 도착해서 확인하셔도 좋아요 / 습관적으로 확인하는 건 더 더 좋아요
    • 깃 활용 능력도 중요하니 자주 자주 해서 익혀봅시다 😄
      • 특별히 유념할 사항들은 🌟깃이슈! 깃 풀리퀘!🌟 입니당

    • 깃허브 tips

      ## github 사용하는 방법

      1. issue 탭에서 todo 추가 -> 템플릿 설정

      2. pull request 탭에서 merge 이후에 development 란에서 issue 연결을 권장합니다.

      3. 추후 issue에서 확인시 풀리퀘 연결되는 것을 확인 할 수 있습니다.

      • 깃모지
        • https://inpa.tistory.com/entry/GIT-⚡️-Gitmoji-사용법-Gitmoji-cli ⇒ 너무 어렵다 하면 성공한 사람이 다운 시켜주세용
        • commit -m “feat: ”
        • 깃모지 쓰기!!

      • 그래도 자주 쓰는 것!!!!!!

        1
2

          git pull origin main
  git checkout -b 

        1
2

          git add .
  gitmoji -c
        • git push origin branch명

        그 외 자주 안 쓰이지만 알아두면 좋은 것들

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

          #Git 기본 명령어
            
  현재 상태 확인 git status 
            
  전체 로그 확인 git log git 저장소 
            
  생성하기 git init 저장소 
            
  복제 및 다운로드 git clone [https: ~~~~ ] 
            
  저장소에 코드 추가git addgit add * 
            
  커밋에 파일의 변경 사항을 한번에 모두 포함  git add -A 
            
  커밋 생성git commit -m "message" 
            
  변경 사항 원격 서버 업로드 (push)git push origin master 
            
  원격 저장소의 변경 내용을 현재 디렉토리로 가져오기 (pull)git pull 
            
  변경 내용을 merge 하기 전에 바뀐 내용 비교git diff [브랜치 이름] [다른 브랜치 이름]        
  --------------------------------------------------------------------------------------------
  #Git Branch 관련 (생성, 브랜치 확인, push 까지의 과정 포함)
            
  git init을 설정하면 해당 폴더에 .git 이라는 파일이 생성됨 git init 
            
  github 주소와 연결 git remote add origin [github 주소] 
            
  브랜치 생성git branch [브랜치명] 
            
  해당 브랜치로 이동git checkout [브랜치명] 
            
  브랜치를 생성하고 해당 브랜치로 바로 이동 git checkout -b [브랜치명] 
            
  원하는 브랜치로 이동했는지 확인 git branch 
            
  모든 브랜치 확인 git branch -a 
            
  파일 및 폴더 addgit add . 
            
  커밋 git commit -m "commit message" 
            
  원하는 브랜치로 push하여 원격 서버에 전송 git push origin [브랜치명] 
            
  브랜치 삭제 git branch -d [브랜치 이름] 
            
  현재 브랜치에 다른 브랜치 수정사항 병합git merge [다른 브랜치 이름]       
  --------------------------------------------------------------------------------------------
  #Git Config 설정 관련  
            
  전체 config 리스트 확인 git config --list 
            
  git config 설정하는 방법git config --global user.name "홍길동"
            
  git config --global user.email "name@naver.com" 
            
  git config 삭제하기 git config --unset user.name
            
  git config --unset user.email 
            
  삭제해도 계속 남아있는 경우 global 옵션을 주어 설정했을 것임, global로 설정된 사용자를 지울 경우 아래와 같이 global 추가 
  git config --unset --global user.email

  2. 점심 - 노션 확인

    기능명세서 템플릿 및 양식

    레퍼런스 템플릿

    간트차트 템플릿

  3. 코드 작업 시 확인
    • ERD (Entity 설계도) https://gudrms92.tistory.com/6
    • 기능 명세서 ( 본인이 작업하는 부분 in progress로 바꿔주기 )
      • 서로의 작업 진행도를 묻지 않고도 보기 쉬우니 배려하는 마음가짐으로 부탁드려요
    • 현재 사용하는 git branch
      • 메인에서 작업하지 않도록 합니다..
      • 메인에서 작업 하셔도 괜찮지만 모든 책임은 스스로에게 있다는 점! 유의하세요

사담

🌟API 명세서🌟

  • 저는 RESTful API를 제작하는 프로젝트를 상대적으로 자주 많이 하기 때문에 api 명세서가 필수였어요. 자동화 도구로 swagger UI도 있지만 개인적으로 별로.. 마음에 들지 않아 postman과 노션을 사용했답니다.

API명세서 템플릿

🌟ReadME 작성🌟

  • 포폴용 아니면 저도 귀찮아서 잘 안 씁니다. 아래 내용을 들고, 내용 대강 쓴 다음에 chat gpt 돌리세요 (사실 이보다 더 나은 템플릿이 많으니 좀 더 검색해봅시다!)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# 프로젝트명

## 프로젝트 개요

### 주제 및 선정 배경

Do-Tori는 사용자들이 자신의 할 일 목록을 공유하고, 질문과 답변을 주고받을 수 있는 커뮤니티 앱입니다. 이 앱을 통해 사용자는 자신의 할 일을 효율적으로 관리하고, 다른 사용자들과 소통하며 도움을 받을 수 있는 편리한 환경을 제공받게 됩니다. 

**기획의도**: 사용자가 자신의 할 일을 공유하며 함께한다는 가치에서 오는 생산성 향상에 기반하여, todo와 community 기능을 결합하게 되었습니다. 커뮤니티에서 소외감을 느끼지 않도록 AI 답변 기능을 추가하여 질문에 대한 즉각적인 답변을 받을 수 있게 했습니다.

<img src="./google_form.png" width="700">

### 🔎 Team Member

| 역할 | 이름 |
| --- | --- |
| 프로젝트 리더 (PL) | 팀원 1 |
| 팀원 | 팀원 2 |
| 팀원 | 팀원 3 |
| 팀원 | 팀원 4 |

### 프로젝트 개요

블로그 및 게시판 형식을 활용한 커뮤니티 사이트 개발

**앱 이름**: Do-Tori 🌰

#### 기능 소개

1. **Todo-Tori (메인 기능)**
    - 할 일 목록 관리 페이지 제공

2. **My Page**
    - 로그인, 로그아웃 기능 제공
    - 회원 탈퇴 및 회원 정보 수정 가능

3. **커뮤니티**
    - 하루 목록을 공유할 수 있는 게시판

4. **튜토리얼**
    - 앱 사용 방법을 안내하는 이미지 기반 튜토리얼 제공

### 활용 장비 및 재료

<img src="./tool.png" width="700">

- PostMan
- IntelliJ
- Java 17 SDK
- GitHub
- Notion
- KakaoTalk
- Spring Boot

### 프로젝트 구조

#### ERD 및 아키텍처

<img src="./Architecture.png" width="700">
<img src="./erd.png" width="700">

### 기대 효과

1. **할 일 관리의 효율성 증대**:
    - 사용자는 Do-Tori를 통해 할 일을 관리하고, 날짜별로 정리하여 시각화할 수 있습니다.
    - 이를 통해 일정을 보다 체계적으로 관리할 수 있습니다.

2. **사용자 간의 상호작용 강화**:
    - 커뮤니티 기능을 통해 사용자들은 자신의 경험을 공유하고, 질문과 답변을 주고받을 수 있습니다.
    - 이를 통해 다양한 의견과 지식을 공유하며 서로 도움을 주고받을 수 있습니다.

# 프로젝트 수행결과

- 참고로 깃은 이미지를 업로드 하면 url으로 뜨더라고요 preview 에서 볼 수 있답니다 
Q : preview가 어디에 있나요? 

깃허브 readME.md 편집기에 편집을 누르면 기본적으로 code 항목으로 뜹니다 code 옆에 preview 버튼이 있어요 클릭해보세요! (code를 못찾겠다면 ctrl+f로 검색해보세요)

🌟추천드리는 mind set🌟

  1. 만일 학교 내에서 전공 수업에서 만난 친구들과 팀프로젝트라면 완성은 힘들거라고 생각하면 편합니다… 모두 15~24학점을 듣느라 바빠요
  2. 만일 방학에 친한 친구들끼리 모여서 프로젝트를 하고 싶다고 생각하면 완성은 힘들것 같다고 생각하세요 모두 자기 살기 바쁘고 방학이라 일정이 많아요…
  3. 부트 캠프라고 개개인의 노력으로 프로젝트 완성을 보장하지 않는걸 유의하세요… 팀프로젝트에서 완성은.. 기대하지 않는게 마음이 편해요..
  4. 직장인들끼리 or 기술 레벨이 높은 사람들끼리 진행한다면 일정이 도 아니면 모입니다.. 일주일만에 모든게 결론지어지거나 차일피일 미뤄지다 7개월만에 프로젝트 파토나거나… 둘 중 하나였어요
  5. 팀프로젝트는 반드시 모두가 떠나도 나 혼자 완성 시킬정도의 양을 목표로 시작하는게 좋다고 생각해요! 😀
    • 생각보다 확인, 글 읽기, 공지 확인, 카톡 확인, 읽기, 문서쓰기에 어려워하고 귀찮아하시는 분도 계시고, 앞에서는 좋다, 최고다 하지만 절대 실천하지 않는 사람도 많아요
    • 이 때문에 협의하는 과정이 코드보다 더 많은 에너지가 허비되는 편이라서 볼륨을 작게 두고 차츰 키워나가는 걸 추천드리는 편이에요~

🌟위 모든 걸 해낸 프로젝트들🌟

  • 제가 만든 프로젝트들입니다 자랑하려구 올려놔요 히

Do-Tori 발표

2NY 발표

Project, Do-tori
project
This post is licensed under CC BY 4.0 by the author.