리드미에도 어느정도 양식을 갖추어 쓰는 것이 중요하다. 보기 편한 리드미는 채점하기 편한 리드미, 채점하기 편한 리드미는 합격하기 좋은 리드미.
1. 리드미의 필수 구성요소
1) gif나 동영상 등, 시각적 요소
-
사람들이 내가 만든걸 보기 위해서 ide를 깔고 클론을 받고 패키지를 설치하고, 그걸 실행할 컴퓨터와 환경이 필요하다면 대부분의 사람들은 귀찮아서 안보는 쪽을 택할 것이다.
-
내가 다른 사람의 프로젝트를 파악하기 위해서 어떻게 하는지 생각해보고 내가 가장 보기 편했던 형태로 보여주기 위해 노력하자.
-
동영상은 내가 원하는 부분만 볼수가 없다. 재생버튼을 누르기 전까진 이게 내가 원하는 부분인지도 확신할 수 없고, 짤로 만드는게 제일 좋은 것 같다.
-
gif 만들기
- 준비물1 : 영역지정해서 영상을 녹화할 수 있는 프로그램.
워터마크 없음 + 영역지정 + 무료 = ocam이 적당했다.
- 준비물2 : 그걸 gif로 바꿔주는 사이트 : https://ezgif.com/
- 준비물3 : 깔끔한 사이트 정리와 크롬 개발자도구의 네트워크 설정 -
예쁜 코드블록 만들기 : https://carbon.now.sh/
이건 ppt같이 발표할때 좋을듯
2) 설치, 환경설정 및 실행방법
- 누구나 켤수 있게 만들기
1. git clone https://github.com/matty255/wanted-pre-onboarding-challenge-fe-1.git
2. cd [folder name]
3. cd client
4. yarn install
5. yarn start (리액트가 켜지길 기다립니다.)
6. ctrl + c (터미널에서!)
7. yarn build
8. 빌드되는걸 기다립니다.
9. cd ..
10. cd server
11. yarn install
12. yarn start (노드가 켜지길 기다립니다.)
13. ctrl + c (터미널에서!)
14. cd ..
15. 경로가 최상위 디렉토리인지 확인(client와 server가 보이는 그 위치!)
16. 최상위 디렉토리에서 yarn install
17. 같은 디렉토리에서 yarn start!
를 하면 이제 실행이 가능하지만 만약 api서버가 이미 켜져있고 다른 곳에 있다면
client 부분만 clone해서
1. cd client
2. yarn install
3. yarn start
도 가능합니다!- 이런느낌으로 하면 된다.
3) 구현 요구 사항 목록
- 과제페이지에 써있는 걸 가져와서 체크박스형태로 매겨주면 된다.
- 더 잘 구현했거나 어필하고 싶은 부분은 마크다운 문법을 써서 강조해도 좋음
4) 사용한 프레임워크 및 라이브러리 설명
package.json을 보면서 적으면 좋다.
a. 필수적인거 먼저 적기
- 과제에서 사용해달라고 공식적으로 표시된거 먼저 적기
b. 왜 선택했는지 적기
- 이걸 사용함으로써 얻을 수 있는 것
- 어느 용도로 어느 범위만큼 사용했는지
- 다른 옵션은 무엇이 있었는지(ex - redux, recoil 등)
5) 폴더 구조 설명
- tree 명령어를 써서 폴더구조를 만들고 만약 리팩토링을 했다면 before와 after로 나눠주어도 좋다.
- 아키텍쳐에 대해 이해하고 있다는 어필을 하면 좋다.
6) 코드 설명
- 과제 진행 시 내가 고민했던 부분, 잘 살리고 싶었던 부분 기술
- 한계점과 미처 못했던 부분, 다음에 더 잘하고 싶은 부분 기술
- 트러블슈팅 적기
- 너무 길어진다면 이슈로 빼고 링크 달기
이걸 열심히 적용해서 만든 리드미!
https://github.com/matty255/wanted-pre-onboarding-challenge-fe-1
It's an adventure time!