Github 프로젝트 readme 작성

😎 포함되어야 하는 정보들

😀 1. 프로젝트에 대한 정보

프로젝트 제목

• GitHub Repository 이름이나 프로젝트 제목을 적어준다.

프로젝트 로고나 이미지

프로젝트를 대표하는 사진이나 로고를 넣어준다. 너비를 300정도로 해주는 것이 보기 좋고, 가운데 정렬!

프로젝트 정보

해당 프로젝트를 진행한 단체나 목적에 대해 소개하고, 개발 기간을 써준다.

배포 주소

• 프로젝트가 배포되어 있다면 해당 주소를 기입.

팀 소개

프로젝트를 팀으로 진행하였다면, 팀원들에 대한 소개를 써준다.

프로젝트 소개

진행한 프로젝트에 대해 간단하게 5~10줄 정도 써준다.

😀 2. 기술 스택

프로젝트를 개발하는데 사용한 기술스택들을 적어준다. 줄글로 적어줘도 되지만, 기술스택 배지를 사용하면 더 효과적이고, 있어보이게 표현할 수 있다.

프로젝트에 사용한 기술스택을 크게 Environment, Config, Development, Communication 4가지로 나눴고, 상황에 따라 test나 deploy도 추가하면 좋을 것 같다.

😀 3. 화면구성 / API 주소

프론트엔드의 경우에는 개발한 화면에 대한 내용을 적어주고, 백엔드의 경우에는 API 주소 목록이나 이를 기록한 링크를 걸어두면 좋을 것 같다.

😀 4. 주요 기능

프로젝트의 주요 기능들을 소개하기

😀 5. 아키텍처

프로젝트의 아키텍쳐와 디렉토리 구조에 대해 작성.