docman

mango

Una aplicación de gestión de documentos

Introducción

• DocMan es un sistema de administración de documentos que expone puntos finales utilizando API RESTFUL.
• Tiene las siguientes características:
  • Acceso
  • Inscribirse
  • Encuentra un usuario
  • Encuentra todos los usuarios
  • Buscar documentos
  • Buscar usuarios
  • Crear documentos
  • Eliminar documentos, usuarios
  • Actualizar documentos, usuarios
• La documentación de la API se puede encontrar aquí

Dependencia del proyecto

Dependencias

• Babel -Cli - Permite ejecutar la aplicación en modo ES6 sobre la marcha sin tener que trasladar a ES5
• Babel-Preset-ES2015 , Babel-Preset-Stage-0 : estos paquetes proporcionan presets Babel para complementos ES2015, Plugins de etapa 0
• BCryptJS : se usa para las contraseñas de hash
• Body -Parser - Node.js Middleware de análisis del cuerpo. Analice los cuerpos de solicitud entrantes en un middleware antes de sus manejadores, disponibles bajo la propiedad req.body .
• Dotenv - Cargas Variables de entorno
• Express : utilizado como servidor web para esta aplicación
• JSONWebToken : genera tokens JWT y puede verificarlos
• PG - Cliente PostgreSQL sin bloqueo para Node.js. JavaScript puro y enlaces de libpq nativos opcionales
• SECLELIZE - SECLELIZE es un Node.js ORM basado en promesa para Postgres, MySQL, SQLite y Microsoft SQL Server. Cuenta con soporte de transacciones sólidas, relaciones, replicación de lectura y más

Dependencias de desarrollo

• Chai - Chai es una biblioteca de afirmación BDD / TDD para el nodo y el navegador que puede emparejarse deliciosamente con cualquier marco de prueba JavaScript.
• Coverls - Coveralls.io Soporte para Node.js. Obtenga el excelente informe de cobertura de Coveralls.io y agregue un botón de cobertura genial a su lectura.
• Gulp : Gulp es un kit de herramientas que lo ayuda a automatizar tareas dolorosas o que requieren mucho tiempo en su flujo de trabajo de desarrollo.
• Gulp -Babel - Use JavaScript de próxima generación, hoy, con Babel
• Gulp-Inject Modules : carga los archivos JavaScript a pedido de una transmisión Gulp al cargador del módulo de nodo.
• Estambul : genera cobertura de prueba
• Gulp-desgaño-mocha -llame a mocha-cli de Gulp
• Mocha - JavaScript Test Framwork
• Gulp -Nodemon - es Gulp + Nodemon + Comendience
• SECLELIZE -CLI : la interfaz de línea de comandos de secuela (CLI)
• Supertest - Afirmaciones HTTP facilitadas a través de Superagent.

Instalación y configuración

• Navegue a un directorio usando su terminal favorito.

• Clonar este repositorio a ese directorio.

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

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

• Navegue al directorio del repositorio

• $ cd document-manager

• Instale las dependencias de la aplicación

• $ npm install

• Ejecutar la aplicación

• $ npm start

Pruebas

• Las pruebas se escribieron usando Supertest, Chai.
• La cobertura de prueba es generada por el paquete istanbul
• Para ejecutar pruebas, navegue al directorio raíz del proyecto
• Ejecute los siguientes comandos.
• $ npm test

Cómo contribuir

Para contribuir, se deben seguir ciertas pautas y guías de estilo. Hay más información disponible en la wiki del repositorio.
Para contribuir, desembolse este repositorio a su repositorio privado y cree una solicitud de extracción basada en la función que desea agregar.

Descargo de responsabilidad

Esta aplicación y sus funciones están limitadas por la restricción de tiempo y no es de ninguna manera en su mejor momento.

Preguntas frecuentes

• ¿Cómo contribuyo a este proyecto?
  • Lee la wiki
  • Bifurca el repositorio y plantea una solicitud de extracción cuando estás DOBE
• ¿Cuánto tiempo será compatible con esta API?
  • Mientras hay usuarios
• ¿Cómo reporto un error?
  • Plantear un problema que le dice lo que estaba tratando de hacer cuando ocurrió el error
  • y el mensaje de error

Licencia

Licencia incluida en el repositorio

Autor

Olufisayo bamidele