Docman
문서 관리 응용 프로그램
소개
-
DocMan Restful API를 사용하여 엔드 포인트를 노출시키는 문서 관리 시스템입니다. - 다음과 같은 기능이 있습니다.
- 로그인
- 가입
- 한 명의 사용자를 찾으십시오
- 모든 사용자를 찾으십시오
- 문서 검색
- 사용자를 검색하십시오
- 문서를 만듭니다
- 문서, 사용자를 삭제하십시오
- 문서, 사용자를 업데이트하십시오
- API 문서는 여기에서 찾을 수 있습니다
프로젝트 종속성
의존성
- Babel -Cli- ES5로 변환하지 않고 ES6 모드에서 앱을 즉시 실행할 수 있습니다.
- Babel-Preset-ES2015 , Babel-Preset-Stage-0- 이 패키지는 ES2015 플러그인, Stage 0 플러그인에 Babel 사전 설정을 제공합니다.
- bcryptjs- 암호를 해시하는 데 사용됩니다
- Body -Parser -Node.js Body Parsing Middleware. 수신 요청 본문을 핸들러 앞에 미들웨어에 구문 분석하여
req.body 속성에 따라 사용할 수 있습니다. - dotenv- 환경 변수를로드합니다
- Express- 이 응용 프로그램의 웹 서버로 사용
- JSONWEBTOKE- JWT 토큰을 생성하여 확인할 수 있습니다
- PG- Node.js의 비 차단 PostgreSQL 클라이언트 순수한 JavaScript 및 옵션 원시 LIBPQ 바인딩
- 속편 - 속편은 Postgres, MySQL, SQLite 및 Microsoft SQL Server의 Promise -Based Node.js ORM입니다. 견고한 거래 지원, 관계, 읽기 복제 등이 있습니다.
개발 종속성
- Chai -Chai는 Node 용 BDD / TDD Assertion Library로, JavaScript 테스트 프레임 워크와 즐겁게 짝을 이룰 수있는 브라우저입니다.
- Coverals -Coveralls.io node.js. Coverals.io에 대한 훌륭한 커버리지보고를 받고 readme에 멋진 커버리지 버튼을 추가하십시오.
- Gulp -Gulp는 개발 워크 플로에서 고통 스럽거나 시간이 많이 걸리는 작업을 자동화하는 데 도움이되는 툴킷입니다.
- Gulp -Babel- 오늘날 바벨과 함께 차세대 자바 스크립트를 사용하십시오
- gulp-inject-modules- gulp 스트림에서 Node의 모듈 로더로 주문형 자바 스크립트 파일을로드합니다.
- 이스탄불 - 테스트 범위를 생성합니다
- Gulp-Spawn-Mocha- Gulp에서 Mocha-Cli에 전화하십시오
- Mocha -JavaScript 테스트 framwork
- Gulp -Nodemon- Gulp + Nodemon + 편의성입니다
- 후속작 -CLI- 속편 명령 줄 인터페이스 (CLI)
- SUPERTEST -HTTP Assertions는 초고속을 통해 쉽게 만들었습니다.
설치 및 설정
좋아하는 terminal 사용하여 디렉토리로 이동하십시오.
이 저장소를 해당 디렉토리로 복제하십시오.
SSH 사용; $ git clone [email protected]:andela-obamidele/docman.git
HTTP 사용; $ git clone https://github.com/andela-obamidele/docman.git
Repo의 디렉토리로 이동하십시오
$ cd document-manager
앱의 종속성을 설치하십시오
$ npm install
앱을 실행하십시오
$ npm start
테스트
- 테스트는 Supertest, Chai를 사용하여 작성되었습니다.
- 테스트 범위는
istanbul 패키지에 의해 생성됩니다 - 테스트를 실행하려면 프로젝트의 루트 디렉토리로 이동하십시오
- 다음 명령을 실행하십시오.
-
$ npm test
기여하는 방법
기여하려면 특정 지침과 스타일 가이드를 따라야합니다. 더 많은 정보는 Repo 's Wiki에서 확인할 수 있습니다.
기여하려면이 저장소를 개인 저장소에 포크하고 추가하려는 기능을 기반으로 풀 요청을 작성하십시오.
부인 성명
이 앱과 그 기능은 시간 제약으로 제한되며 최선을 다하지 않습니다.
FAQ
- 이 프로젝트에 어떻게 기여합니까?
- 위키를 읽으십시오
- repo를 포크하고 당신이 할 때 풀 요청을 제기하십시오.
- 이 API는 얼마나 오래 지원됩니까?
- 버그를 어떻게보고합니까?
- 오류가 발생했을 때 당신이 무엇을하려고했는지 말하는 문제를 제기
- 그리고 오류 메시지
특허
저장소에 포함 된 라이센스
작가
Olufisayo Bamidele
