README.md

📋 Handover - 국방업무공유체계

Documentation  |  Presentation  |  Demo Video

👋 프로젝트 소개 (Project Introduction)

Handover는 군 내의 인수인계를 효율적이고 편리하게 진행할 수 있도록 돕는 Web 서비스입니다.

Handover는 보직 변경 등의 상황에서 효율적이고 정확하지 않은 인수인계로 인해
새로운 업무 환경에 적응하는 것에 어려움을 겪거나 업무의 공백이 생기는 문제점을 해결하고자 합니다.

더 나아가, 부대 간 효율적인 업무 방법을 공유하는
통합적 업무 공유 플랫폼을 제공하는 것을 목표로 하고 있습니다.

📖 목차

1. 기능 설명
2. 컴퓨터 구성 / 필수 조건 안내
3. 기술 스택
4. 기대 효과
5. 경쟁력
6. 설치 안내
7. 프로젝트 사용법
8. Handover에 기여하는 법
9. 소스코드 구조
10. 팀 정보
11. 저작권 및 사용권 정보

✨ 기능 설명 (Key Features)

Handover만의 3가지 핵심 기능과 함께 더 편리하고 똑똑한 인수인계를 진행해보세요!

• 3단계 문서 구성 으로 체계적인 인수인계 문서
• 그룹, 북마크, 댓글 기능들로 공유하는 인수인계 문서
• 보안 관리자 기능으로 보안위반으로부터 안전한 인수인계 문서

🗄️ 3단계 문서 구성

Handover 내의 모든 문서는 🗄️ 서랍, 📰 문서, 📇 카드 의 3단계 구성을 갖습니다.

• 서랍: 부서 또는 보직에 연관된 문서들의 집합
• 문서: 하나의 업무를 구성하는 카드들의 집합
• 카드: 작은 업무를 수행하는 방법을 설명한 짧은 글

3단계 문서 구성과 문서 작성 가이드를 통해 더 읽기 쉽고, 체계화된 문서를 작성해보세요!

🤝 문서 공유 서비스

• 같은 보직, 같은 소속의 사용자들과 인수인계 문서를 공유하고, 댓글을 통해 의견을 나누어보세요!
• 마음에 드는 문서가 있다면, 북마크 기능을 통해 언제든지 문서를 다시 열람할 수 있습니다.

🔐 보안 관리자 등록을 통한 기밀 유출 방지

• 그룹 별로 보안 관리자를 등록해 그룹 내 문서에서 보안 사항이 위반되고 있는지 확인하고, 관리할 수 있습니다.

🔎 컴퓨터 구성 / 필수 조건 안내 (Prerequisites)

Chrome	Edge	FireFox	Safari
✔ (84+)	✔ (84+)	✔ (63+)	✔ (14.1+)

✨ Handover 의 기대효과 (Expectations)

👍 인수인계 방식의 체계화

• 공통된 인수인계 문서 작성 플랫폼을 통한 인수인계 방식 통일
• 3단계 문서 구성을 통한 인수인계의 효율성 및 정확도 향상
• 인수인계 방식의 개선으로 군 장병의 업무 적응기간 단축 기대

🤝 부대 간 정보 공유 확대

• 업무 문서를 공유해 부대 간 소통 확대
• 사용자들의 의견 공유를 통한 업무 효율성 상승
• 노하우 공유를 통한 업무 능률 증폭

🔥 Handover 가 가진 경쟁력 (Competitiveness)

📊 인수인계 문서의 데이터화

• 사용자들의 업무 수행 문서들을 국방과학연구소, 국방정책실 등의 기관에서 연구데이터로 활용 가능
• 실무에서의 업무처리 방식 및 문제점을 확인하고 개선하여 군 전체의 발전 기대

📖 오픈소스로써의 Handover

• API Doc, Database Schema를 제공함으로써 오픈소스 개발자들의 지속적 개발 지원
• Editor내 표 작성, 수식 작성 기능 등 사용자들이 필요로 하는 기능들을 추가하며 성장 가능

🛠️ 기술 스택 (Key Tech Stacks)

🚉 Platform

• docker
• docker-compose
• nginx

🛒 Back-end

• Node.js
• Express
• jsonwebtoken
• MongoDB
• Mongoose
• Algolia

💄 Front-end

• React
• Redux
• MaterialUI
• Sass
• webpack

🚀 설치 안내 (Installation Methods)

1. Repository Clone

터미널(또는 콘솔)에서 다음 명령어 실행

git clone https://github.com/osamhack2021/Web_Handover_Handover.git handover && cd handover

2. Docker 설정

사용하는 운영체제에 맞는 Docker 설치

3. Docker 실행

프로젝트 root 폴더에서 터미널을 열고 다음 명령어 실행

npm run prd

4. 프로젝트 실행 확인

localhost 에서 서비스되고 있는 Handover 확인

5. Docker 중지

Ctrl + C 를 눌러서 터미널에서 실행되던 Docker 중지

🏃 프로젝트 사용법 (Getting Started)

Handover는 별도의 설정이나 메뉴얼 없이도 직관적인 UI를 통해 바로 사용이 가능합니다!

🙌 Handover에 기여하는 법 (How to contribute)

Handover는 오픈소스 프로젝트로, 여러분들의 도움을 기다리고 있습니다.
Handover에 기여하고 싶으시다면, CONTRIBUTING.md 을 참고해주세요.

🕹️ 소스코드 구조 (Source Code Structure)

WEB(FE)

/frontend

WEB(BE)

/backend

👨‍👦‍👦 팀 정보 (Team Info)

사진
이름	조나단	안수겸	김태원	최우혁	박현준	오지환
역할	팀장 프론트엔드	디자인 프론트엔드	프론트엔드	프론트엔드	백엔드	백엔드
GitHub
이메일

📝 저작권 정보 (Copyright)

• MIT License