docman

ドキュマン

ドキュメント管理アプリケーション

導入

• DocMan Restful APIを使用してエンドポイントを公開するドキュメント管理システムです。
• 次の機能があります。
  • ログイン
  • サインアップ
  • 1人のユーザーを見つけます
  • すべてのユーザーを見つけます
  • ドキュメントを検索します
  • ユーザーを検索します
  • ドキュメントを作成します
  • ドキュメント、ユーザーを削除します
  • ドキュメント、ユーザーを更新します
• APIドキュメントはこちらでご覧いただけます

プロジェクトの依存関係

依存関係

• BABEL -CLI- ES5に透過することなく、ES6モードでアプリをその場で実行することができます
• BABEL-PRESET-ES2015 、 BABEL-PRESET-STAGE-0-これらのパッケージは、ES2015プラグイン、ステージ0プラグインのバベルプリセットを提供します
• BCRYPTJS-ハッシュパスワードに使用されます
• Body -Parser -node.jsボディの解析ミドルウェア。 req.bodyプロパティの下で入手可能なハンドラーの前に、中程度のリクエスト本体を中央のリクエストボディを解析します。
• dotenv-環境変数をロードします
• Express-このアプリケーションのWebサーバーとして使用
• JsonWebtoken -JWTトークンを生成し、それらを確認できます
• PG -Node.jsの非ブロッキングpostgresqlクライアント純粋なJavaScriptとオプションのネイティブLibpqバインディング
• Sequelize -Sequelizeは、Postgres、MySQL、SQLite、Microsoft SQL Serverの約束ベースのnode.js ormです。堅実なトランザクションサポート、関係、読み取りレプリケーションなど

開発依存関係

• CHAI -CHAIは、ノードとブラウザ用のBDD / TDDアサーションライブラリであり、JavaScriptテストフレームワークと楽しくペアリングできます。
• coveralls -coveralls.io node.jsのサポートCoveralls.ioの素晴らしいカバレッジレポートを取得し、CoolカバレッジボタンをREADMEに追加します。
• Gulp -Gulpは、開発ワークフローで痛みを伴うまたは時間のかかるタスクを自動化するのに役立つツールキットです。
• Gulp -Babel-バベルと一緒に、次世代のJavaScriptを使用してください
• Gulp-Inject-modules -javascriptファイルをgulpストリームからノー​​ドのモジュールローダーにオンデマンドでロードします。
• イスタンブール- テストカバレッジを生成します
• Gulp-Spawn-Mocha -GulpからMocha-Cliに電話してください
• Mocha -JavaScriptテストフラムワーク
• Gulp -Nodemon -Gulp + Nodemon + Convenienceです
• Secelize -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

• リポジトリのディレクトリに移動します

• $ cd document-manager

• アプリの依存関係をインストールします

• $ npm install

• アプリを実行します

• $ npm start

テスト

• テストは、Supertest、Chaiを使用して作成されました。
• テストカバレッジは、 istanbulパッケージによって生成されます
• テストを実行するには、プロジェクトのルートディレクトリに移動します
• 次のコマンドを実行します。
• $ npm test

貢献する方法

貢献するには、特定のガイドラインとスタイルガイドに従う必要があります。詳細については、リポジトリのWikiをご覧ください。
貢献するには、このレポをプライベートリポジトリにフォークし、追加する機能に基づいてプルリクエストを作成します。

免責事項

このアプリとその機能は、時間の制約によって制限されており、最高の状態ではありません。

FAQ

• このプロジェクトに貢献するにはどうすればよいですか
  • wikiを読んでください
  • あなたがdobeであるときにレポをフォークし、プルリクエストを上げます
• このAPIはどのくらいサポートされますか
  • ユーザーがいる限り
• バグを報告するにはどうすればよいですか
  • エラーが発生したときにあなたが何をしようとしていたかを伝える問題を提起する
  • エラーメッセージ

ライセンス

リポジトリに含まれるライセンス

著者

Olufisayo Bamidele