docman Download - docman Source Code Download

docman

Anderer Quellcode

Herunterladen

Docman

Eine Dokumentverwaltungsanwendung

Einführung

DocMan ist ein Dokumentverwaltungssystem, das Endpunkte mit einer erholsamen API enthüllt.
Es hat die folgenden Funktionen:
- Login
- Melden Sie sich an
- Suchen Sie einen Benutzer
- Finden Sie alle Benutzer
- Suche nach Dokumenten
- Suche nach Benutzern
- Dokumente erstellen
- Dokumente löschen, Benutzer
- Aktualisieren Sie Dokumente, Benutzer
Die API -Dokumentation finden Sie hier

Projektabhängigkeiten

Abhängigkeiten

Babel -cli - Ermöglicht das Ausführen der App im ES6 -Modus im laufenden Fliegen, ohne auf ES5 nach unten zu transportieren zu müssen
Babel-Preset-ES2015 , Babel-Preset-Stage-0 -Diese Pakete bieten Babel-Voreinstellungen für ES2015-Plugins, Stufe 0-Plugins
Bcryptjs - Wird für Hash -Passwörter verwendet
Body -Parser - Node.js Body Parsing Middleware. Anfragen Sie eingehende Antragsbehörden in einer Middleware vor Ihren Handlern an, die unter der Immobilie req.body verfügbar sind.
dotenv - lädt Umgebungsvariablen
Express - als Webserver für diese Anwendung verwendet
JSONWEBTOKE - generiert JWT -Token und kann sie überprüfen
PG - Nicht blockierender PostgreSQL -Client für node.js. Reine JavaScript- und optionale native LIBPQ -Bindungen
Sequelize - Sequelize ist ein vielversprechender node.js orm für Postgres, MySQL, SQLite und Microsoft SQL Server. Es verfügt über solide Transaktionsunterstützung, Beziehungen, Replikation und mehr

Entwicklungsabhängigkeiten

CHAI - Chai ist eine BDD / TDD -Assertion -Bibliothek für Knoten und den Browser, das herrlich mit jedem JavaScript -Test -Framework gepaart werden kann.
Coveralls - Coveralls.io Support für node.js. Holen Sie sich die großartige Berichterstattung über Coveralls.io und fügen Sie Ihrem Readme einen coolen Taste für die Berichterstattung hinzu.
Gulp - Gulp ist ein Toolkit, mit dem Sie schmerzhafte oder zeitaufwändige Aufgaben in Ihrem Entwicklungsworkflow automatisieren können.
Gulp -Babel - Verwenden Sie heute JavaScript der nächsten Generation mit Babel
Gulp-Inject-Modules -Lädt JavaScript-Dateien On-Demand von einem Gulp-Stream in den Modulload des Knotens.
Istanbul - Erzeugt die Testabdeckung
Gulp-Spawn-Mocha -Rufen Sie Mocha-Cli von Schlupf an
Mokka - JavaScript -Test Framwork
Gulp -Nodemon - Es ist Schluck + Nodemon + Bequemlichkeit
Folgene -Cli - Die Folge -Befehlszeilenschnittstelle (CLI)
Supertest - HTTP -Behauptungen, die über SuperAgent einfach gemacht wurden.

Installation und Setup

Navigieren Sie mit Ihrem Lieblingsterminal zu einem terminal .
Klonen Sie dieses Repository in dieses Verzeichnis.
Mit SSH; $ git clone [email protected]:andela-obamidele/docman.git
Mit HTTP; $ git clone https://github.com/andela-obamidele/docman.git
Navigieren Sie zum Verzeichnis des Repos
$ cd document-manager
Installieren Sie die Abhängigkeiten der App
$ npm install
Führen Sie die App aus
$ npm start

Tests

Die Tests wurden mit Supertest, Chai, geschrieben.
Die Testabdeckung wird vom istanbul -Paket erzeugt
Um Tests auszuführen, navigieren Sie zum Stammverzeichnis des Projekts
Führen Sie die folgenden Befehle aus.
$ npm test

Wie man beiträgt

Um einen Beitrag zu leisten, müssen bestimmte Richtlinien und Stilführer befolgt werden. Weitere Informationen finden Sie im Wiki des Repos.
Um einen Beitrag zu leisten, geben Sie dieses Repo in Ihr privates Repository und erstellen Sie eine Pull -Anfrage basierend auf der Funktion, die Sie hinzufügen möchten.

Haftungsausschluss

Diese App und ihre Funktionen sind durch zeitliche Einschränkungen begrenzt und sind in keiner besten Seite.

FAQs

Wie halte ich zu diesem Projekt bei
- Lesen Sie das Wiki
- Geben Sie das Repo auf und stellen Sie eine Pull -Anfrage auf, wenn Sie DOBE sind
Wie lange wird diese API unterstützt?
- Solange es Benutzer gibt
Wie melde ich einen Fehler
- Machen Sie ein Problem an, das Ihnen mitteilt, was Sie versucht haben, wenn der Fehler aufgetreten ist
- und die Fehlermeldung