/consult-api

API desenvolvida durante a segunda fase do ioasys-camp 2021 na trilha back-end com uma equipe formada por desenvolvedores web front-end, android, ios, designer e scrumaster.

Primary LanguageJavaScript

camp-21 | Time 2

Observações

  • Depois que configurar o banco de dados renomeie o arquivo '.env.exemple' para '.env' coloque os valores de acordo com o banco criado.
  • rode o comando 'yarn install'
  • rode o comando 'yarn sequelize-cli db:migrate'
  • rode o comando 'yarn sequelize-cli db:seed:all'
  • rode o comando 'yarn start:dev'

  • Cadastro de Usuários
  • Alteração do Perfil
  • Listagem de Profissionais
  • Solicitação de Consulta
  • Confirmar Consulta
  • Cancelar de Consulta
  • Histórico de Consulta
  • Avaliação de consulta

Instruções

  • Crie um banco de dados para desenvolvimento
  • Crie um banco de dados para testes
  • Ronomeie o arquivo .env.exemple para .env
  • Coloque as respecivas informações no arquivo .env
  • execute "yarn test" dentro do diretorio raiz do projeto
    • Se algum teste falhar será nescessario apagar os dados escritos no banco manualmente usando "yarn clear:db:test"
    • Se todos os teste passarem execute as migrations com "yarn migrate"
  • Execute os seeders com "yarn seedAll"
  • "yarn start:dev" e a aplicação já estará rodando em ambiente de desenvolvimento

Observações

  • No arquivo .env, os valores das variáveis precisam ser de acordo com as que você possui no seu ambiante, o arquivo .env.example é so um modelo de quais variáveis são necessárias para o projeto.

Sequelize

  • O Sequelize é o ORM que utilizamos nesse projeto, ele nos ajuda facilitando a comunicação entre nossa aplicação e o banco de dados. Ele possui uma documentação bem completa que pode ser consultada no link abaixo.

  • Documentação

  • Lembrete: Para o Sequelize funcionar, você já precisa ter criado o banco que será utilizado, inclusive o banco de testes, e depois só passar os nomes desses bancos no arquivo .env, a sua aplicação também vai precisar ter a lib do banco que você está utilizando, (caso seja Postgresql o driver já está instalado) é possível ver um exemplo neste link da documentação.

Postman

  • Este é o link da collection que criei no postman com as rotas de login e listagem de usuários, para utiliza-la basta abrir o postman e importar via link e colocar o seguinte link https://www.getpostman.com/collections/079c561b35bb6e1cbc11.