Git Product home page Git Product logo

fx's Introduction

fx

Olá! Ben vindo ao sistema de desafio da F(x).

Aqui estão as instruções para rodar o mesmo.

Ao fazer o clone do projeto, deve executar o seguinte comando para instalar as dependências:

npm install

Os scripts que criam os bancos de dados usado pela aplicação encontra-se dentro do diretório 'scripts' na raíz do projeto.

As bases criadas esperam que exista um usuário no PostgreSQL chamado 'nodejs' com uma senha 'nodejsapp'

Para executar o projeto basta executar o comando:

npm start 

O package.json já tem uma entrada de script para executar a partir do arquivo app.js.

O servidor node escutará na porta 8080

A documentação dos endpoints ficará disponível na url http://host:8080/apidoc

Para executar os testes automatizados de integração do Mocha, deverá setar a variável de ambiente para reconhecer o banco de teste, da seguinte forma

NODE_ENV=test node_modules/mocha/bin/mocha

Abaixo seguem os endpoints criados e quais exigem ou não token de autenticação.

Cabe lembrar que quando o login é executado com sucesso é devolvido um objeto JSON cujo primeiro elemento é o token que deverá ser usado no HEADER das demais requisições.

Deverá haver uma nova entrada no HEADER chamada "x-access-token", cujo value é o token retornado no login.

Se for realizada uma tentativa de acesso para qualquer endpoint controlado sem o devido envio do token, haverá o retorno com status 400, contendo a mensagem de token não localizado.

Se tentar realizar o login de um usuário que não existe, também retornará um JSON com status 400 contendo o endpoint para o cadastro de um novo usuário

/salva-lista --token --POST { nome: 'Nome de algum objeto', descricao: 'Alguma descricao', valor_medio: 169.22 }

/lista --token --get sem parâmetros

/lista-por-nome --token --get exemplo... /lista-por-nome?nome=postgresql

/atualiza-lista --post --token { id: 5, nome: 'Nome qualquer', descricao: 'descricao qualquer', valor_medio: 158.66

}

/login --post --sem token { email: '[email protected]', senha: 'teste' }

/login/new --post --sem token { email: '[email protected]', senha: 'qualquersenha', nome: 'nome do usuário' }

/login/update-profile --post --token { nome: 'nome do usuario' }

/login/update-address --post --token { cep: '03386170' }

fx's People

Contributors

edwi-feitoza avatar

Stargazers

Pedro avatar

Watchers

James Cloos avatar  avatar

Forkers

pedrualves

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.