Download do docman - Download do código -fonte docman

docman

Outro código-fonte

Baixar

Docman

Um aplicativo de gerenciamento de documentos

Introdução

DocMan é um sistema de gerenciamento de documentos que expõe pontos de extremidade usando API RESTful.
Tem os seguintes recursos:
- Conecte-se
- Inscrever-se
- Encontre um usuário
- Encontre todos os usuários
- Procure documentos
- Procure usuários
- Criar documentos
- Exclua documentos, usuários
- Atualize documentos, usuários
A documentação da API pode ser encontrada aqui

Dependências do projeto

Dependências

Babel -cli - permite executar o aplicativo no modo ES6 em tempo real sem ter que transpilar para ES5
BABEL-PRESET-ES2015 , BABEL-PRESET-STAGE-0 -Esses pacotes fornecem predefinições Babel para plugins ES2015, plugins de estágio 0
BCRYPTJS - Usado para hash senhas
Body -Parser - Node.js Body Parsing Middleware. Analise os órgãos de solicitação de entrada em um middleware antes dos manipuladores, disponíveis na propriedade req.body .
dotenv - carrega variáveis de ambiente
Express - usado como servidor da web para este aplicativo
JSONWEBTOKEN - gera tokens JWT e pode verificá -los
PG - Cliente PostgreSQL não bloqueador para Node.JS. JavaScript puro e ligações nativas opcionais Libpq
Sequelize - Sequelize é um Node.js ORM baseado em promessa para Postgres, MySQL, SQLite e Microsoft SQL Server. Possui suporte de transação sólida, relações, replicação e muito mais

Dependências de desenvolvimento

Chai - Chai é uma biblioteca de asserção BDD / TDD para o Node e o navegador que pode ser deliciosamente emparelhado com qualquer estrutura de teste JavaScript.
CoverAlls - Coveralls.io Suporte para Node.js. Obtenha a ótima reportagem de cobertura do Coveralls.io e adicione um botão de cobertura legal ao seu ReadMe.
Gulp - Gulp é um kit de ferramentas que ajuda a automatizar tarefas dolorosas ou demoradas no seu fluxo de trabalho de desenvolvimento.
Gulp -Babel - Use JavaScript da próxima geração hoje, com Babel
Módulos de injeção de gole -carrega arquivos JavaScript sob demanda de uma corrente de gole para o carregador de módulos do Node.
Istambul - gera cobertura de teste
Gulp-Spawn-Mocha -Ligue para Mocha-cli da Gulp
Mocha - JavaScript Test Framwork
Gulp -nodemon - é gulp + nodemon + conveniência
Sequelize -cli - a interface da linha de comando sequelize (CLI)
Supertest - asserções HTTP facilitadas via SuperAgent.

Instalação e configuração

Navegue para um diretório usando seu terminal favorito.
Clone este repositório a esse diretório.
Usando ssh; $ git clone [email protected]:andela-obamidele/docman.git
Usando http; $ git clone https://github.com/andela-obamidele/docman.git
Navegue até o diretório do repo
$ cd document-manager
Instale as dependências do aplicativo
$ npm install
Execute o aplicativo
$ npm start

Testes

Os testes foram escritos usando o Supertest, Chai.
A cobertura do teste é gerada pelo pacote istanbul
Para executar testes, navegue para o diretório raiz do projeto
Execute os seguintes comandos.
$ npm test

Como contribuir

Para contribuir, certas diretrizes e guias de estilo devem ser seguidos. Mais informações estão disponíveis no wiki do repo.
Para contribuir, bata este repositório para o seu repositório privado e crie uma solicitação de tração com base no recurso que você deseja adicionar.

Isenção de responsabilidade

Este aplicativo e suas funções são limitados pela restrição de tempo e não estão de forma alguma.

Perguntas frequentes

Como faço para contribuir com este projeto
- Leia o wiki
- Bifurque o repositório e aumente um pedido de tração quando você estiver fazendo
Quanto tempo esta API será suportada
- Contanto que haja usuários
Como faço para relatar um bug
- Levante um problema dizendo o que você estava tentando fazer quando ocorreu o erro
- e a mensagem de erro