사이드프로젝트 백엔드 깃헙 readme 작성

Question

진행하고 있는 사이드 프로젝트가 ec2 사용이라 무료 기간 끝나면 서버 배포를 중단할건데 이러면 깃헙 readme에 배포 서버를 작성해놨어도 볼 방법이 없는데 이를 위해 readme에 api 명세서를 캡쳐한거나 그런거를 적어놓는게 좋을까요 아니면 어떤 내용을 더 넣어두는게 좋을지 고민입니다.현재는프로젝트 설명, 기술 스택, 배포 링크, api 링크, erd, 주요 기능 간략하게만 작성되어있거든요. 그런데 나중에 배포 중단하게되면 사이트 링크랑 api 링크 전부 접속 불가능하니까 너무 텅 빌 것 같아서 어떤게 좋을지 모르겠네요

カワウソ · Accepted Answer

실제로 로컬 실행을 해보는 면접관은 없겠지만 그럼에도 로컬 실행 환경을 구성하는 방법만 적는게 좋다고 생각하는데요.프로덕션을 위한 환경 구성 가이드나 운영 시 주의 사항은 위키로 적어놔도 무방하지 않을까 싶네요.아래의 오픈소스의 위키 문서를 참고해보세요.https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install

사이드프로젝트 백엔드 깃헙 readme 작성

1개의 답변

Q&A 목록