[DOC] Readme.md
riyenas0925 opened this issue · 10 comments
분야별 저장소
팀소개
'폰 좀 내이만(Pon Johm Naimann)' 팀은 생활관 병사 스마트폰 비대면 반납 시스템 개발을 목표로 '국방모바일반납' 프로젝트를 진행하고 있습니다.
본 프로젝트는 IoT, APP, WEB 기술을 모두 결합함으로써, 간편하고 체계적인 반납 시스템을 구축하면서도 그 속에서 병사가 느끼는 부담을 최소화하는 것을 목적으로 개발을 진행하고 있습니다.
본 프로젝트는 오픈소스 프로젝트로 진행되며, 본 프로젝트에 관심이 있는 개발자, 사용자들을 위해 튜토리얼 GitBook을 제작하여 공개하고 있습니다.
프로젝트 설명 동영상
기능 설계
IoT 반납기
QR코드 인식, 무게 감지, 문 잠금, 서버와의 통신 등의 기능이 탑재되어 있습니다. 기기에서 반납 APP을 켜고 반납기에 넣으면 자동으로 QR코드를 감지하고 반납 기록을 서버에 전송합니다.
APP
초기 등록시에 서버와 통신하여 기기를 등록한 뒤, 이후에는 Time-based OTP기술을 활용해 기기 고유의 QR코드를 출력합니다. 이 앱은 어떠한 권한도 요구하지 않습니다.
WEB(Back-End API Server)
기기 관리자 현황, 등록 기기 현황, 기기 반납 현황을 관리하는 서버입니다. 각종 API를 지원하며, 주로 POST와 GET을 통해 요청을 받습니다.
WEB(Front-End)
Argon Dashboard를 관리자용 페이지를 제작하였으며, 간편하게 반납 정보 조회 및 관리를 할 수 있도록 제작되었습니다.
컴퓨터 구성 / 필수 조건 안내 (Prerequisites)
- IoT 반납기: 라즈베리파이 3B,B+, 4B 사용, 아두이노 나노 V3
- App: 안드로이드 00이상
- WEB:
기술 스택 (Technique Used)
- IoT 사용 라이브러리
- pyzbar (MIT)
- pillow (HPND)
- opencv-python (MIT)
- picamera (BSD)
- serial (MIT)
- numpy (BSD)
- pybase64 (BSD)
-
APP
-
WEB
설치 안내 (Installation Process)
자세한 빌드 방법은 아래 튜토리얼 페이지를 참고하십시오.
프로젝트 사용법 (Getting Started)
자세한 사용 방법은 아래 튜토리얼 페이지를 참고하십시오.
팀 정보 (Team Information)
- park chan jeong (ckswjd99@gmail.com), Github Id: ckswjd99
- kang dong min (riyenas0925@gmail.com), Github Id: riyenas0925
- lee jin whuy (jinwhuy.lee@gmail.com), Github Id: jinwhuy
저작권 및 사용권 정보 (Copyleft / End User License)
Pon Johm Naimann에 의해 창작된 본 저장소의 모든 내용들은 크리에이티브 커먼즈 [저작자표시-동일조건변경허락 4.0 국제 (CC BY-SA 4.0)]에 따라 이용할 수 있습니다.Introduction
국방모바일보안은 병사와 통제간부 모두가 만족하며 사용할 수 있는, 일방적인 금지와 통제로 이루어지지 않는 스마트폰 반납 시스템을 개발하기 위한 프로젝트입니다. IoT, APP, WEB 분야의 기술을 함께 사용합니다.
Manual
본 프로젝트는 오픈소스 프로젝트로 진행되며, 본 프로젝트에 관심이 있는 개발자와 사용자를 위하여 튜토리얼 GitBook을 제작하여 공개하고 있습니다.
Contribution
금년도 오픈소스아카데미 집체교육이 비대면으로 이루어짐에 따라, 모든 프로젝트는 서로 얼굴도 알지 못하는 상태에서 진행됩니다. 따라서 소통은 실시간 소통이 가능하고 문서화에 유리한 아래의 Notion 페이지에서 이루어집니다.
License
라이센스의 구체적인 내용 및 써드파티 SW에 대해서는 본 리포지토리의 LICENSE 파일 및 튜토리얼 GitBook의 LICENSE 페이지를 참조하십시오.
- IoT
- Code for Arduino: GPLv3.0
- Code for RaspberryPi: BSD-3
- APP: BSD-3
- WEB: BSD-3
Copyright
Pon Johm Naimann에 의해 창작된 본 저장소의 모든 내용들은 크리에이티브 커먼즈 [저작자표시-동일조건변경허락 4.0 국제 (CC BY-SA 4.0)]에 따라 이용할 수 있습니다.WEB Repository
IoT Repository
App Repository
팀소개
'폰 좀 내이만(Pon Johm Naimann)' 팀은 생활관 병사 스마트폰 비대면 반납 시스템 개발을 목표로 '국방모바일반납' 프로젝트를 진행하고 있습니다.
본 프로젝트는 IoT, APP, WEB 기술을 모두 결합함으로써, 간편하고 체계적인 반납 시스템을 구축하면서도 그 속에서 병사가 느끼는 부담을 최소화하는 것을 목적으로 개발을 진행하고 있습니다.
본 프로젝트는 오픈소스 프로젝트로 진행되며, 본 프로젝트에 관심이 있는 개발자, 사용자들을 위해 튜토리얼 GitBook을 제작하여 공개하고 있습니다.
프로젝트 설명 동영상
기능 설계
IoT 반납기
QR코드 인식, 무게 감지, 문 잠금, 서버와의 통신 등의 기능이 탑재되어 있습니다. 기기에서 반납 APP을 켜고 반납기에 넣으면 자동으로 QR코드를 감지하고 반납 기록을 서버에 전송합니다.
APP
초기 등록시에 서버와 통신하여 기기를 등록한 뒤, 이후에는 Time-based OTP기술을 활용해 기기 고유의 QR코드를 출력합니다. 이 앱은 어떠한 권한도 요구하지 않습니다.
WEB(Back-End API Server)
기기 관리자 현황, 등록 기기 현황, 기기 반납 현황을 관리하는 서버입니다. 각종 API를 지원하며, 주로 POST와 GET을 통해 요청을 받습니다.
WEB(Front-End)
Argon Dashboard를 관리자용 페이지를 제작하였으며, 간편하게 반납 정보 조회 및 관리를 할 수 있도록 제작되었습니다.
컴퓨터 구성 / 필수 조건 안내 (Prerequisites)
- IoT 반납기: 라즈베리파이 3B,B+, 4B 사용, 아두이노 나노 V3
- App: 안드로이드 00이상
- WEB:
기술 스택 (Technique Used)
- IoT 사용 라이브러리
- pyzbar (MIT)
- pillow (HPND)
- opencv-python (MIT)
- picamera (BSD)
- serial (MIT)
- numpy (BSD)
- pybase64 (BSD)
-
APP
-
WEB
설치 안내 (Installation Process)
자세한 빌드 방법은 아래 튜토리얼 페이지를 참고하십시오.
프로젝트 사용법 (Getting Started)
자세한 사용 방법은 아래 튜토리얼 페이지를 참고하십시오.
팀 정보 (Team Information)
- park chan jeong (ckswjd99@gmail.com), Github Id: ckswjd99
- kang dong min (riyenas0925@gmail.com), Github Id: riyenas0925
- lee jin whuy (jinwhuy.lee@gmail.com), Github Id: jinwhuy