getwlad/mentora-me

Projeto Integrador do curso back-end da digital house em parceria com ifood.

mentora-me

Índice

• Sobre o Projeto
• Documentação
• Instalação
• Uso da API
• Tecnologias e Recursos
• Sprints
• Equipe
• Agradecimentos

Sobre o projeto

Projeto Integrador do curso de back-end da Digital House em parceria com o iFood através do Potência Tech.

Esta API tem como objetivo atender a requisições em um sistema que fará a conexão entre alunos e mentores através de um match (combinação) que leva em consideração os interesses do cliente/aluno e retorna as informações do profissional/mentor mais adequado para seu perfil. Dessa maneira, a Mentora-me é uma plataforma desenvolvida para auxiliar indivíduos que buscam praticidade e a melhor solução para o crescimento em suas carreiras.

Documentação

• Mentora-me

Instalação

Utilize o mentora-me localmente com o npm.

  git clone git@github.com:getwlad/mentora-me.git
  cd mentora-me
  npm i
  # instalar dependências
  cp .env.example .env
  # modificar variáveis de ambiente no .env
  npm start

Uso da API

Criar um novo usuário (ex.: Student):

  POST /user/

Parametro	Tipo	Descrição
email	string	Required. Email do usuário
password	string	Required. Senha do usuário
user_type	string	Required. Tipo de usuário (mentor / student)

Cadastro do aluno:

  POST /student/

Parametro	Tipo	Descrição
name	string	Required. Nome do aluno
cpf	string	Required. CPF do aluno
phone	string	Required. Telefone do aluno

Cadastro da Área de Interesse:

  POST /student/interest

Parametro	Tipo	Descrição
mentoringArea	string	Required. Nome da área de interesse (ex.: Banco de Dados)

Cadastro das caracteristicas do aluno:

  POST /student/particulars

Valores de 1 a 3 para determinar o quanto cada característica deve ser priorizada no match.

Parametro	Tipo	Descrição
theory	string	Required. (ex.: 1)
practice	string	Required. (ex.: 3)
...	string	...

Match:

  GET student/match/

Retorna o mentor com mais compatibilidade.

Sprints

A implementação do projeto se deu por 5 sprints:

Sprint	Descrição
Sprint 1	Análise de requisitos para produção.
Sprint 2	CRUD dos usuários e definição da arquitetura.
Sprint 3	Modelagem do banco de dados.
Sprint 4	Implementação do Sequelize e principais funcionalidades da API.
Sprint 5	Implementação de testes e API externa para transações financeiras.

Tecnologias e Recursos Utilizados

Equipe

• Ludmila
  • Email | Github | LinkedIn
• Thayná
  • Email | Github | LinkedIn
• Wladmir
  • Email | Github | LinkedIn

Agradecimentos

iFood | Digital House | Potência Tech

⬆ voltar ao início