Skip to content

Commit

Permalink
Merge pull request #80 from turkey-kim/feat/doc
Browse files Browse the repository at this point in the history
docs: 찐막
  • Loading branch information
turkey-kim authored Sep 22, 2023
2 parents d57a796 + 9116a0a commit 53e7fff
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@
## 🧑🏻‍💻 프로젝트 소개
Toy Project로 제작된 `Yanolja Tech School Wiki`[야놀자 테크 스쿨](https://fastcampus.co.kr/b2g_yanoljatechschool)에 대한 다양한 정보를 담고 있는 Wiki 웹 사이트입니다.

### [필수 구현사항]

✅ 문서편집, revision 기능을 제공하여 업무일지를 작성할 수 있는 직원들을 위한 위키사이트 구현(마크다운 형식)
✅ firebase database (Firestore) 이용
✅ 모달을 활용한 근무 시간을 표시하는 시계 및 타이머 창 구현
✅ 캐러셀을 활용한 회사 공지 페이지
**갤러리 페이지 / 업무일지 페이지 등 메뉴를 필터링 또는 카테고리화 하는 선택바 구현**
✅ netlify 등을 이용한 정적 페이지 배포 (firebase + github actions)
✅ TypeScript 사용 필수
✅ 과제에 대한 설명을 포함한 `README.md` 파일 작성
✅ 팀원별로 구현한 부분 소개

### [선택 구현사항]

✅ React 사용은 선택
✅ 기타 동작이 완료되기 전에 로딩 애니메이션 구현
✅ 관련된 기타 기능도 고려 (공부 시간 랭킹 구현)
✅ eslint 설정, 커밋컨벤션, 문서화 등 팀프로젝트시 필요한 추가 작업들

<details>
<summary>야놀자 테크 캠프 토이 프로젝트 설명</summary>

Expand Down Expand Up @@ -182,7 +201,7 @@ my-wiki-app/

### Gallery
![갤러리1](https://github.com/turkey-kim/techschool_wiki/assets/101972330/2439807e-9457-4f50-9f4f-ac17d2c61a1e)
![갤러리2](https://github.com/turkey-kim/techschool_wiki/assets/101972330/9f19e4bf-7456-416e-a6e9-d090e73ab047)
![갤러리2](https://github.com/turkey-kim/techschool_wiki/assets/101972330/9b403572-0f27-425f-9c1a-5da32f0f05ef)

### Timer + Ranking
![타이머](https://github.com/turkey-kim/techschool_wiki/assets/101972330/7812cc2c-90b6-49d1-b939-22ede5c6c67a)
Expand Down

0 comments on commit 53e7fff

Please sign in to comment.