Skip to content

Latest commit

 

History

History
366 lines (299 loc) · 14.6 KB

readme.pt_BR.md

File metadata and controls

366 lines (299 loc) · 14.6 KB

CircleCI PRs Welcome GitHub license All Contributors

Como a idéia surgiu?

A idéia veio de uma reunião de amigos que apenas se conheciam pela internet, cada um com suas particularidades linguísticas, daí pensamos em um dicionário informal para expressões do idioma que cada região brasileira possui, então o projeto foi totalmente colaborativo, trazendo diversidade cultural de cada um de nós, possibilitando aprofundar-se na cultura cotidiana do nosso português brasileiro.

Projetos usando o dialects-service

📃 API

Todos os endpoints ativos estão na URL https://dialetus-service.herokuapp.com e geralmente seguem a arquitetura REST.

Todas as requisições devem ser codificadas como JSON com o cabeçalho Content-Type: application/json. A maioria das respostas, incluindo erros, também é codificada exclusivamente como JSON.

Estrutura do dialect object

O objeto dialect na pasta dialects tem os seguintes campos:

{
  "dialect": String,
  "meanings": Array<String>,
  "examples": Array<String>,
  "synonyms": Array<String> // (optional)
}

GET /regions

Lista todas as regiões disponíveis com o total de dialetos mapeados.

Request

$ curl https://dialetus-service.herokuapp.com/regions

Response

[{
  "name": "alagoanes",
  "total": 64
}, {
  "name": "amazones",
  "total": 9
}, {
  "name": "baianes",
  "total": 42
}, {
  "name": "carioques",
  "total": 14
}, {
  "name": "catarines",
  "total": 22
}, {
  "name": "cearences",
  "total": 10
}, {
  "name": "gauches",
  "total": 25
}, {
  "name": "lageanes",
  "total": 28
}, {
  "name": "maranhes",
  "total": 15
}, {
  "name": "mineires",
  "total": 26
}, {
  "name": "paraense",
  "total": 30
}, {
  "name": "paranes",
  "total": 53
}, {
  "name": "paulistes",
  "total": 16
}, {
  "name": "pernambuques",
  "total": 17
}, {
  "name": "piauies",
  "total": 30
}, {
  "name": "potiguares",
  "total": 35
}, {
  "name": "rondones",
  "total": 9
}, {
  "name": "sergipanes",
  "total": 11
}]

GET /regions/:region/dialects

Lista todos os dialetos mapeados

Request

$ curl https://dialetus-service.herokuapp.com/regions/baianes/dialects

Response

[
  {
    "slug": "relaxe-mo-fiu",
    "dialect": "Relaxe mô fiu.",
    "meanings": [
      "Sem problemas",
      "Fique tranquilo"
    ],
    "examples": [
      "Ô vei, relaxe mô fiu todo nervoso ele."
    ]
  },
  {
    "slug": "e-bala",
    "dialect": "É bala!",
    "meanings": [
      "algo interessante",
      "massa"
    ],
    "examples": [
      "Que computador bala!"
    ]
  },
  {
    "slug": "comer-agua",
    "dialect": "Comer água!",
    "meanings": [
      "Vodka",
      "Cerveja",
      "Qualquer bebida que contenha álcool"
    ],
    "examples": [
      "Vamo pro reg comer água galera!"
    ]
  },
]

GET /regions/:region/dialects/:slug

Obtém um dialect por slug.

Request

$ curl https://dialetus-service.herokuapp.com/regions/baianes/dialects/relaxe-mo-fiu

Response

{
  "slug": "relaxe-mo-fiu",
  "dialect": "Relaxe mô fiu.",
  "meanings": [
    "Sem problemas",
    "Fique tranquilo"
  ],
  "examples": [
    "Ô vei, relaxe mô fiu todo nervoso ele."
  ]
}

GET /search?q={words}

Procura as palavras em todos os dialetos mapeados.

Request

$ curl https://dialetus-service.herokuapp.com/search?q=regui

Lista de dialetos

GET /dialect

GET /dialect

# /dialect/:region
GET /dialect/baianes
GET /dialect/mineires
GET /dialect/paranes
GET /dialect/carioques
GET /dialect/potiguares
GET /dialect/rondones
GET /dialect/cearences
GET /dialect/pernambuques
GET /dialect/piauies
GET /dialect/catarines
GET /dialect/paraense
GET /dialect/gauches

Response

{
  "baianes": [
    {
      "slug": "regui",
      "dialect": "Regui",
      "meanings": [
          "Reunião com os amigos",
          "Balada",
          "Festa"
      ],
      "examples": [
        "Ô mizera, bora pro regui logo vá!"
      ]
    },
    {
      "slug": "num-to-comeno-regui",
      "dialect": "Num tô comeno regui",
      "meanings": [
        "Não acreditar em algo",
        "Não se importar"
      ],
      "examples": [
        "Num tô comeno regui não viu pae."
      ]
    }
  ]
}

Request

$ curl https://dialetus-service.herokuapp.com/search?q=Virado no cão

Response

{
  "baianes": [{
    "slug": "virado-no-cao",
    "dialect": "Virado no cão",
    "meanings": [
      "Mal humorado",
      "Aborrecido"
    ],
    "examples": [
      "Eu to virado no cão, o primeiro que passar na minha frente vou rumaláporra!"
    ]
  }]
}

Request

$ curl https://dialetus-service.herokuapp.com/search?q=baita

Response

{
  "gauches": [{
    "slug": "baita",
    "dialect": "Baita",
    "meanings": [
      "Grande",
      "Imenso"
    ],
    "examples": [
      "Bah tchê, que baita de um problema tu arranjaste?!"
    ]
  }],
  "paranes": [{
    "slug": "baita",
    "dialect": "Baita",
    "meanings": [
      "grande",
      "enorme",
      "de grandes proporções"
    ],
    "examples": [
      "Mas que baita susto tu me deu"
    ]
  }]
}

Contribute 🍕

01. Instalar dependências

$ yarn

02. Criar configs

Crie um arquivo .env na raiz do projeto. Tenha certeza de que usou o arquivo .env.example como um guia.

03. Executar o projeto

$ yarn dev

04. Aprendendo mais no Guia de comtribuição

Por favor dê uma olhada em contributing guide.

Respect earns Respect 👏

Por favor respeite nosso Código de Conduta, resumindo:

  • Usando linguagem acolhedora e inclusiva
  • Ser respeitoso com diferentes pontos de vista e experiências
  • Aceitando graciosamente críticas construtivas
  • Focar o que é melhor para a comunidade
  • Mostrar empatia com outros membros da comunidade

Autores 😎

Contribuidores 🎉

Obrigado a todas essas pessoas maravilhosas (emoji key):


Marcus Silva

💻 📖 👀

Angelmário Santana

💻 📖 👀

Rodolfo Silva

💻 📖 👀

Bruno Pulis

💻

Wellington Mitrut

💻

Diego Ramos

💻

Caio Alcântara

💻

Lucas Farias

💻

Higor Morais

💻

Medson Mendes

💻

Randѕon Oliveira

💻

Murillo de Miranda Pereira

💻

Rafael Nunes

💻

Will Mendes

💻

kathleenrego

💻

Jader

💻

Rodolfo Candido

💻

Jefferson Moura

💻

Raphael Amorim

💻

Adriano Canofre

💻

Maurício Coelho

💻

Marcela Barella

💻

Matheus Monte

💻

Gabriel Kalani

💻

Ruan Kaylo

💻

Thiago Guimarães

💻

Welkson Ramos

💻

Mateus Malaquias

💻

Licença

Dialetus is released under the MIT license.

Copyright © 2019.