docman Download - docman Source Code Download

docman

Autre code source

Télécharger

Docman

Une application de gestion de documents

Introduction

DocMan est un système de gestion de documents qui expose les points de terminaison à l'aide de l'API RESTFul.
Il a les fonctionnalités suivantes:
- Se connecter
- S'inscrire
- Trouver un utilisateur
- Trouver tous les utilisateurs
- Rechercher des documents
- Rechercher des utilisateurs
- Créer des documents
- Supprimer les documents, les utilisateurs
- Mettre à jour les documents, les utilisateurs
La documentation de l'API peut être trouvée ici

Dépendances du projet

Dépendances

Babel-Cli - Permet d'exécuter l'application en mode ES6 à la volée sans avoir à transpiler à ES5
Babel-Preset-ES2015 , Babel-Preset-Stage-0 - Ces packages fournissent des préréglages Babel pour les plugins ES2015, les plugins de scène 0
BCryptJS - Utilisé pour hacher les mots de passe
Body-Parser - Node.js Analyse du corps middleware. Analyser les corps de demande entrants dans un middleware avant vos gestionnaires, disponibles dans la propriété req.body .
Dotenv - charge des variables d'environnement
Express - utilisé comme serveur Web pour cette application
JSONWEBToken - génère des jetons JWT et peut les vérifier
PG - Client postgresql non bloquant pour node.js. Javascript pur et liaisons libpq natives en option
SECELILSE - SECELILISE est un ORM Node.js basé sur des promesses pour Postgres, MySQL, SQLite et Microsoft SQL Server. Il dispose d'un support de transaction solide, de relations, de lecture de la réplication et plus

Dépendances au développement

Chai - Chai est une bibliothèque Assertion BDD / TDD pour le nœud et le navigateur qui peut être délicieusement associé à n'importe quel cadre de test JavaScript.
CoverAlls - CoverAls.io Prise en charge de Node.js. Obtenez l'excellente couverture de reportage de CoverAlls.io et ajoutez un bouton de couverture cool à votre lecture.
Gulp - Gulp est une boîte à outils qui vous aide à automatiser des tâches douloureuses ou longues dans votre flux de travail de développement.
Gulp-Babel - Utilisez JavaScript de nouvelle génération, aujourd'hui, avec Babel
Gulp-Inject-Modules - Charge les fichiers JavaScript à la demande d'un flux Gulp dans le chargeur de module du nœud.
Istanbul - génère une couverture de test
Gulp-Spawn-Mocha - Appelez Mocha-Cli de Gulp
Mocha - Framwork de test JavaScript
gulp-nodemon - c'est gulp + nodemon + commodité
Sequelize-Cli - L'interface de ligne de commande séquetteuse (CLI)
SuperTest - Assertions HTTP s'est facilitée via SuperAgent.

Installation et configuration

Accédez à un répertoire en utilisant votre terminal préféré.
Clone ce référentiel à ce répertoire.
Utilisation de SSH; $ git clone [email protected]:andela-obamidele/docman.git
En utilisant http; $ git clone https://github.com/andela-obamidele/docman.git
Accédez au répertoire du repo
$ cd document-manager
Installez les dépendances de l'application
$ npm install
Exécutez l'application
$ npm start

Tests

Les tests ont été écrits à l'aide de SuperTest, Chai.
La couverture de test est générée par le package istanbul
Pour exécuter des tests, accédez au répertoire racine du projet
Exécutez les commandes suivantes.
$ npm test

Comment contribuer

Afin de contribuer, certaines directives et guides de style doivent être suivis. Plus d'informations sont disponibles sur le wiki du repo.
Pour contribuer, fourrez ce dépôt à votre référentiel privé et créez une demande de traction en fonction de la fonctionnalité que vous souhaitez ajouter.

Clause de non-responsabilité

Cette application et ses fonctions sont limitées par la contrainte de temps et ne sont en aucun cas à son meilleur.

FAQ

Comment contribuer à ce projet
- Lire le wiki
- Fourk le repo et soulevez une demande de traction lorsque vous êtes dobé
Combien de temps cette API sera-t-elle prise en charge
- Tant qu'il y a des utilisateurs
Comment signaler un bogue
- Soulever un problème en vous indiquant ce que vous essayiez de faire lorsque l'erreur s'est produite
- et le message d'erreur