docman

докман

Приложение для управления документами

Введение

• DocMan - это система управления документами, которая обнажает конечные точки с использованием RESTFUL API.
• Он имеет следующие функции:
  • Авторизоваться
  • Зарегистрироваться
  • Найдите одного пользователя
  • Найдите всех пользователей
  • Поиск документов
  • Поиск пользователей
  • Создать документы
  • Удалить документы, пользователи
  • Обновление документов, пользователей
• Документацию API можно найти здесь

Зависимости проекта

Зависимости

• Babel -Cli - позволяет запустить приложение в режиме ES6 на лету, не транспилируя вниз до ES5
• Babel-Preset-ES2015 , Babel-Preset-Stage-0 -эти пакеты предоставляют плагины Babel для плагинов ES2015, плагины стадии 0
• bcryptjs - используется для хэш -паролей
• Body -Parser - Node.js Промежуточное программное обеспечение. Разрабатывать входящие запросы в промежуточном программном обеспечении перед вашими обработчиками, доступными в рамках свойства req.body .
• dotenv - загружает переменные среды
• Express - используется в качестве веб -сервера для этого приложения
• jsonwebtoken - генерирует токены JWT и может их проверить
• PG - не блокирующий клиент PostgreSQL для node.js. Чистый JavaScript и дополнительные нативные привязки Libpq
• Scentize - Scentize - это Node.js ORM на основе обещаний для Postgres, MySQL, SQLite и Microsoft SQL Server. Он имеет твердую поддержку транзакций, отношения, репликацию и многое другое

Зависимости развития

• Chai - Chai - это библиотека утверждений BDD / TDD для узла и браузера, которая может быть восхитительно в сочетании с любой структурой тестирования JavaScript.
• Coveralls - Soipalls.io Поддержка для node.js. Получите отличное покрытие отчетности Covalls.io и добавьте кнопку Cool Coverge в свой Readme.
• Gulp - Gulp - это инструментарий, который помогает вам автоматизировать болезненные или трудоемкие задачи в вашем рабочем процессе разработки.
• Gulp -Babel - Используйте JavaScript следующего поколения, сегодня с Babel
• Модулы инъекции Gulp -загружает файлы JavaScript по требованию из потока Gulp в загрузчик модуля узла.
• Стамбул - генерирует тестовое покрытие
• Gulp-Spawn-Mocha -Позвоните Mocha-Cli из Gulp
• Mocha - JavaScript Test Framwork
• Gulp -Nodemon - это Gulp + Nodemon + удобство
• Scielize -Cli - интерфейс командной строки Squareize (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

Как внести свой вклад

Чтобы внести свой вклад, необходимо соблюдать определенные руководящие принципы и руководства по стилю. Больше информации доступна на вики репо.
Чтобы внести свой вклад, разобрать это репо в ваш личный репозиторий и создать запрос на тягу на основе функции, которую вы хотите добавить.

Отказ от ответственности

Это приложение и его функции ограничены временными ограничениями и ни в коем случае не являются лучшими.

Часто задаваемые вопросы

• Как мне внести свой вклад в этот проект
  • Читать вики
  • Разветвляется репо и поднимите запрос на привлечение, когда вы добе
• Как долго будет поддерживать этот API
  • Пока есть пользователи
• Как сообщить об ошибке
  • Поднимите проблему, рассказывающая вам, что вы пытались сделать, когда произошла ошибка
  • и сообщение об ошибке

Лицензия

Лицензия, включенная в репозиторий

Автор

Олуфисайо Бамиделе