docman

คนเอกสาร

แอปพลิเคชันการจัดการเอกสาร

การแนะนำ

• DocMan เป็นระบบจัดการเอกสารที่เปิดเผยจุดสิ้นสุดโดยใช้ RESTFUL API
• มีคุณสมบัติดังต่อไปนี้:
  • เข้าสู่ระบบ
  • การลงทะเบียน
  • ค้นหาผู้ใช้หนึ่งคน
  • ค้นหาผู้ใช้ทั้งหมด
  • ค้นหาเอกสาร
  • ค้นหาผู้ใช้
  • สร้างเอกสาร
  • ลบเอกสารผู้ใช้
  • อัปเดตเอกสารผู้ใช้
• เอกสาร API สามารถพบได้ที่นี่

การพึ่งพาโครงการ

การพึ่งพาอาศัยกัน

• Babel -CLI - อนุญาตให้ใช้งานแอพในโหมด ES6 ได้ทันทีโดยไม่ต้องส่งผ่านไปยัง ES5
• BABEL-PRESET-ES2015 , BABEL-PRESET-Stage-0- แพ็คเกจเหล่านี้ให้บริการ BABEL ที่ตั้งไว้ล่วงหน้าสำหรับปลั๊กอิน ES2015, Stage 0 Plugins
• bcryptjs - เคยใช้รหัสผ่านแฮช
• Body -Parser - node.js การแยกตัวของตัวกลางมิดเดิลแวร์ แยกวิเคราะห์ร่างกายที่เข้ามาในมิดเดิลแวร์ก่อนที่ตัวจัดการของคุณจะมีอยู่ภายใต้คุณสมบัติ req.body
• DOTENV - โหลดตัวแปรสภาพแวดล้อม
• Express - ใช้เป็นเว็บเซิร์ฟเวอร์สำหรับแอปพลิเคชันนี้
• JsonWebToken - สร้างโทเค็น JWT และสามารถตรวจสอบได้
• PG - ไคลเอนต์ PostgreSQL ที่ไม่ปิดกั้นสำหรับ Node.JS. จาวาสคริปต์บริสุทธิ์และการผูก LIBPQ ดั้งเดิมที่เป็นตัวเลือก
• Sequelize - Sequelize เป็น Node.js ที่ใช้สัญญาสำหรับ Postgres, MySQL, SQLite และ Microsoft SQL Server มันมีการสนับสนุนการทำธุรกรรมที่มั่นคงความสัมพันธ์อ่านการจำลองและอื่น ๆ

การพัฒนาการพัฒนา

• ชัย - ชัยเป็นไลบรารีการยืนยัน BDD / TDD สำหรับโหนดและเบราว์เซอร์ที่สามารถจับคู่กับกรอบการทดสอบ JavaScript ได้อย่างน่ายินดี
• CoverAlls - CoverAlls.io Support สำหรับ Node.JS. รับการรายงานความคุ้มครองที่ยอดเยี่ยมของ coverallsio และเพิ่มปุ่มครอบคลุมเย็นลงใน readme ของคุณ
• Gulp - Gulp เป็นชุดเครื่องมือที่ช่วยให้คุณทำงานที่เจ็บปวดหรือใช้เวลานานในเวิร์กโฟลว์การพัฒนาของคุณ
• Gulp -Babel - ใช้ JavaScript รุ่นต่อไปในวันนี้กับ Babel
• Gulp-Inject-Modules- โหลดไฟล์ JavaScript ตามความต้องการจากกระแส Gulp ลงในตัวโหลดโมดูลของโหนด
• อิสตันบูล - สร้างความครอบคลุมการทดสอบ
• Gulp-Spawn-Mocha- โทร Mocha-cli จาก Gulp
• Mocha - Framwork ทดสอบ JavaScript
• Gulp -Nodemon - มันคือ Gulp + Nodemon + ความสะดวกสบาย
• Sequelize -cli - อินเตอร์เฟสบรรทัดคำสั่งภาคต่อ (CLI)
• Supertest - การยืนยัน HTTP ทำได้ง่ายผ่าน Superagent

การติดตั้งและการตั้งค่า

• นำทางไปยังไดเรกทอรีโดยใช้ 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
ในการมีส่วนร่วมส้อม repo นี้ไปยังที่เก็บส่วนตัวของคุณและสร้างคำขอดึงตามคุณสมบัติที่คุณต้องการเพิ่ม

คำเตือน

แอพนี้และฟังก์ชั่นของมันถูก จำกัด ด้วยข้อ จำกัด ด้านเวลาและไม่สามารถทำได้ดีที่สุด

คำถามที่พบบ่อย

• ฉันจะมีส่วนร่วมในโครงการนี้ได้อย่างไร
  • อ่านวิกิ
  • แยก repo และยกคำขอดึงเมื่อคุณทำ
• API นี้จะได้รับการสนับสนุนนานแค่ไหน
  • ตราบใดที่มีผู้ใช้
• ฉันจะรายงานข้อผิดพลาดได้อย่างไร
  • เพิ่มปัญหาบอกคุณว่าคุณกำลังพยายามทำอะไรเมื่อเกิดข้อผิดพลาด
  • และข้อความแสดงข้อผิดพลาด

ใบอนุญาต

ใบอนุญาตที่รวมอยู่ในที่เก็บข้อมูล

ผู้เขียน

Olufisayo Bamidele