옵시디언, Obsidian Clone Project

👨‍💻 팀원 소개

이승준	노영재	이서연	마서영	이정민
BE	BE	BE	FE	FE

💡 프로젝트 소개

• 우리 FISA 4기 클라우드 서비스반을 위한 Private Obsidian

- 더욱 저렴하게 옵시디언을 이용해보세요!

🌐 데모링크

비밀번호 0119

📌 기능 요구사항

1. 관리자 기능

1. 관리자는 웹에서 마크다운 에디터를 통해 .md 파일을 작성, 생성할 수 있음,웹 에디터를 적용할 수 있는 라이브러리 활용 필요
2. 관리자는 정적 리소스를 호스팅할 수 있음 ex. .md, .jpg, .png, .webp 등
3. jpg, png와 같은 정적 리소스는 .md 파일 내에 포함되어 퍼블리싱될 수 있음 ex. 텍스트가 작성된 .md 파일 내에 이미지도 포함되어 화면에 출력됨
4. 관리자는 작성한 .md 파일을 배포(Publish)/회수(Unpublish) 할 수 있음 ex. 현재 배포된 페이지 목록 조회 후 간단한 체크 버튼(ex. 배포/회수) 등을 통해 배포/회수할 파일 선택
5. 배포할 파일들은 폴더를 구분하여 배포할 수 있음 ex. JavaScript는 1. Client Side 폴더 내 3.JavaScript 폴더 내에 구성할 수 있음 1. Client Side/ 3.JavaScript 1.JavaScript Overview.md

2. 사용자 기능

1. 사용자는 처음 사용자의 경우 비밀번호를 알아야 페이지에 접근할 수 있음 ex. 해당 페이지에 대한 초기 사용자 경우 루트 페이지 접속 시 먼저 비밀번호를 물어보는 페이지 출력
2. 사용자는 페이지 내에서 검색 기능을 통해 원하는 내용이 포함된 컨텐츠를 검색할 수 있음 ex. .md 파일 제목이나 각 파일 내에 작성된 특정 키워드나 텍스트
   1. 검색 기능은 Ctrl + F와 같은 단축키로도 이용할 수 있음
3. 다크모드
4. (1. 관리자 기능의 5.과 연계되는 기능) 사용자는 각 컨텐츠를 관리자가 구분한 폴더별로 구분하여 접근할 수 있음

🚧 협업 규칙

1. 협업 전략

• dev브랜치에서 feat/{작업내용}으로 분기하여 모든 코드는 dev 브랜치에 통합하고, 최종 배포 시 main 브랜치에 반영합니다.
• 작업 프로세스:
  • (1) 이슈 발생: 작업내용(Todo)을 기재합니다.
  • (2) 브랜치 생성: 이슈 번호를 기반으로 작업 브랜치를 생성합니다.
  • (3) 코드 작성: 브랜치에서 작업 후 변경사항을 커밋합니다.
  • (4) Pull Request: dev 브랜치로 병합을 요청합니다.

2. Branch 이름

{feat/fix}-{개발 기능}

• ex) feat/markdown