fabioaromanini / trampei

Plataforma online feita para a disciplina de Engenharia de Software. Desenvolvida em Node, utilizando Express e React. https://trampei-layout-alternativo.herokuapp.com

Trampei backend

A trampei é uma plataforma online voltada para divulgação de trampos rápidos e informais. A versão estável mais atual pode ser acessada no servidor de testes.

Desenvolvido utilizando: nodejs, express, docker, mongo e react.

Para rodar o repositório localmente, é necessário configurar um arquivo JSON com o nome local.json no diretório "/config/credentials/. O json deve conter a seguinte estrutura:

{
  "google": {
    "clientID":
      "Client ID gerado pela API Google",
    "clientSecret": "Client Secret gerado pela API Google",
  },
  "mongo": {
    "uri": "uri para a instância do MongoDB"
  },
  "cookieKey": "String aleatória usada no hash do cookie"
}

Para gerar uma imagem docker, é necessário configurar um script com o nome entrypoint.sh no diretório principal da aplicação. O script deve conter a seguinte estrutura:

#!/bin/sh

export GOOGLE_CLIENT_ID="Client ID gerado pela API Google"
export GOOGLE_CLIENT_SECRET="Client Secret gerado pela API Google"
export MONGO_URI="uri para a instância do MongoDB"
export COOKIE_KEY="String aleatória usada no hash do cookie"

npm start

API

/auth/google: GET redireciona para a tela de login do google /auth/logout: GET desloga o usuário /auth/current: GET retorna o usuário autenticado com base ao cookie enviado pelo cliente /api/trampos?quantity=Integer&userId=String: GET retorna os trampos mais atuais com base nos queryParams. Caso o parametro userId não seja passado, a api retornará os trampos de todos os usuários. /api/trampos: POST cria um novo trampo. Requer o seguinte payload

{
  "userId": "String"
  "userName": "String"
  "trampo": "String"
  "when": "String"
  "where": "String"
  "contact": "String"
  "value": "Schema.types.Double"
}

Informações uteis

• O script npm run dev executa simultaneamente o back e o frontend ambos com hot reloading, para fins de desenvolvimento.
• Instância remota e gratuíta de MongoDB
• Como criar Client ID para OAuth 2.0 com Google ATENÇÃO: ao configurar as credenciais para o ambiente local, as chaves devem autorizar o redirecionamento para "http://localhost:5000/auth/google/callback" e "http://localhost:3000/auth/google/callback", e aceitar como origem "http://localhost:5000".