Skip to content

API to Informal dictionary for the idiomatic expressions that each Brazilian region It has

License

Notifications You must be signed in to change notification settings

mvfsillva/dialetus-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CircleCI PRs Welcome GitHub license All Contributors

How did the idea come about?

The idea came about through the meeting of friends who only knew each other through the internet, each one with its linguistic-cultural traits, we thought of creating an informal dictionary for the idiomatic expressions that each Brazilian region possessed, so the project was totally collaborative, bringing cultural diversity from each one of us, being able, to deepen in the our Brazilian's daily culture.

Projects using the dialects-service

πŸ“ƒ API

All endpoints live under the URL https://dialetus-service.herokuapp.com and then generally follow the REST architecture.

All requests must be encoded as JSON with the Content-Type: application/json header. Most responses, including errors, are encoded exclusively as JSON as well.

Structure of dialect object

The dialect object in dialects folder has the following fields:

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

GET /regions

List all regions available with the total mapped dialects.

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

List all dialects mapped.

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

Get a dialect by 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}

Search the words in all dialects mapped.

Request

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

List of dialects

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"
    ]
  }]
}

GET /flags

List all flags of a dialects available.

Request

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

Response

{
    "flags": [
        {
            "key": "alagoanes",
            "url": "https://mydomain.com.br/database/flags/alagoanes.svg"
        },
        {
            "key": "amazones",
            "url": "https://mydomain.com.br/database/flags/amazones.svg"
        },
        {
            "key": "baianes",
            "url": "https://mydomain.com.br/database/flags/baianes.svg"
        },
        {
            "key": "carioques",
            "url": "https://mydomain.com.br/database/flags/carioques.svg"
        },
        {
            "key": "catarines",
            "url": "https://mydomain.com.br/database/flags/catarines.svg"
        },
        {
            "key": "cearences",
            "url": "https://mydomain.com.br/database/flags/cearences.svg"
        },
        {
            "key": "gauches",
            "url": "https://mydomain.com.br/database/flags/gauches.svg"
        },
        {
            "key": "lageanes",
            "url": "https://mydomain.com.br/database/flags/lageanes.svg"
        },
        {
            "key": "maranhes",
            "url": "https://mydomain.com.br/database/flags/maranhes.svg"
        },
        {
            "key": "mineires",
            "url": "https://mydomain.com.br/database/flags/mineires.svg"
        },
        {
            "key": "paraense",
            "url": "https://mydomain.com.br/database/flags/paraense.svg"
        },
        {
            "key": "paranes",
            "url": "https://mydomain.com.br/database/flags/paranes.svg"
        },
        {
            "key": "paulistes",
            "url": "https://mydomain.com.br/database/flags/paulistes.svg"
        },
        {
            "key": "pernambuques",
            "url": "https://mydomain.com.br/database/flags/pernambuques.svg"
        },
        {
            "key": "piauies",
            "url": "https://mydomain.com.br/database/flags/piauies.svg"
        },
        {
            "key": "potiguares",
            "url": "https://mydomain.com.br/database/flags/potiguares.svg"
        },
        {
            "key": "rondones",
            "url": "https://mydomain.com.br/database/flags/rondones.svg"
        },
        {
            "key": "sergipanes",
            "url": "https://mydomain.com.br/database/flags/sergipanes.svg"
        }
    ]
}

GET /flags/:key

Get a dialect flag by key.

Request

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

Response

{
    "flag": {
        "key": "baianes",
        "url": "https://mydomain.com.br/database/flags/baianes.svg"
    }
}

Contribute πŸ•

01. Install dependencies

$ yarn

02. Create configs

Create a .env file at the root of the project. Make sure you follow the .env.example file as a guide.

03. Run project

$ yarn dev

04. Learn more in the Contributing guide

Please take a look at the contributing guide.

Respect earns Respect πŸ‘

Please respect our Code of Conduct, in short:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Authors 😎

Maintainers

Contributors πŸŽ‰

Thanks goes out to all these wonderful people (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

πŸ’»

License

Dialetus is released under the MIT license.

Copyright Β© 2019.