docman

Docman

Aplikasi Manajemen Dokumen

Perkenalan

• DocMan adalah sistem manajemen dokumen yang memaparkan titik akhir menggunakan API REST.
• Ini memiliki fitur berikut:
  • Login
  • Mendaftar
  • Temukan satu pengguna
  • Temukan semua pengguna
  • Cari Dokumen
  • Cari pengguna
  • Buat dokumen
  • Hapus dokumen, pengguna
  • Perbarui dokumen, pengguna
• Dokumentasi API dapat ditemukan di sini

Ketergantungan Proyek

Dependensi

• Babel -cli - memungkinkan menjalankan aplikasi dalam mode ES6 dengan cepat tanpa harus ditranspile ke ES5
• Babel-Preset-ES2015 , Babel-Preset-Stage-0 -Paket-paket ini menyediakan preset babel untuk plugin ES2015, plugin tahap 0
• BCRYPTJS - Digunakan untuk Hash Kata Sandi
• Body -Parser - Node.js Middleware Parsing Tubuh. Parse Badan Permintaan yang masuk di middleware di depan penangan Anda, tersedia di bawah properti req.body .
• dotenv - variabel lingkungan muatan
• Express - digunakan sebagai server web untuk aplikasi ini
• jsonwebtoken - menghasilkan token jwt dan dapat memverifikasinya
• PG - Klien PostgreSQL Non -Blocking untuk Node.js. Javascript murni dan binding libpq asli opsional
• Sequelize - Sequelize adalah node.js orm berbasis janji untuk Postgres, MySQL, SQLite dan Microsoft SQL Server. Ini fitur dukungan transaksi yang solid, hubungan, replikasi baca dan banyak lagi

Ketergantungan pembangunan

• Chai - Chai adalah pustaka pernyataan BDD / TDD untuk Node dan browser yang dapat dipasangkan dengan menyenangkan dengan kerangka pengujian JavaScript.
• Coveralls - Dukungan coveralls.io untuk node.js. Dapatkan pelaporan cakupan yang bagus dari coveralls.io dan tambahkan tombol cakupan keren ke readme Anda.
• Gulp - Gulp adalah toolkit yang membantu Anda mengotomatisasi tugas yang menyakitkan atau memakan waktu dalam alur kerja pengembangan Anda.
• Gulp -Babel - Gunakan JavaScript generasi berikutnya, hari ini, dengan Babel
• Gulp-Inject-Modules -Memuat file JavaScript On-Demand dari Stream Gulp ke Node's Module Loader.
• Istanbul - Menghasilkan Cakupan Uji
• Gulp-Spawn-Mocha -Hubungi Mocha-Cli dari Gulp
• Mocha - JavaScript Test Framwork
• gulp -nodemon - Ini gulp + nodemon + kenyamanan
• Sequelize -Cli - Antarmuka baris perintah sekuelisasi (CLI)
• Supertest - Pernyataan HTTP menjadi mudah melalui superagent.

Instalasi dan Pengaturan

• Arahkan ke direktori menggunakan terminal favorit Anda.

• Kloning repositori ini ke direktori itu.

• Menggunakan ssh; $ git clone [email protected]:andela-obamidele/docman.git

• Menggunakan http; $ git clone https://github.com/andela-obamidele/docman.git

• Arahkan ke direktori repo

• $ cd document-manager

• Instal Ketergantungan Aplikasi

• $ npm install

• Jalankan aplikasi

• $ npm start

Tes

• Tes ditulis menggunakan Supertest, Chai.
• Cakupan uji dihasilkan oleh paket istanbul
• Untuk menjalankan tes, arahkan ke direktori root proyek
• Jalankan perintah berikut.
• $ npm test

Bagaimana berkontribusi

Untuk berkontribusi, pedoman dan panduan gaya tertentu harus diikuti. Info lebih lanjut tersedia di wiki repo.
Untuk berkontribusi, garpu repo ini ke repositori pribadi Anda dan buat permintaan tarik berdasarkan fitur yang ingin Anda tambahkan.

Penafian

Aplikasi ini dan fungsinya dibatasi oleh batasan waktu dan sama sekali tidak sama sekali.

FAQ

• Bagaimana cara berkontribusi pada proyek ini
  • Baca wiki
  • Membayar repo dan angkat permintaan tarik saat Anda dobe
• Berapa lama API ini akan didukung
  • Selama ada pengguna
• Bagaimana cara melaporkan bug
  • Naikkan masalah yang memberi tahu Anda apa yang Anda coba lakukan saat kesalahan terjadi
  • dan pesan kesalahan

Lisensi

Lisensi termasuk dalam repositori

Pengarang

Olufisayo Bamidele