Lexicon API

API para o Lexicon, um jogo de adivinhação de palavras baseado em outros jogos do gênero, como o Wordle e Termo. 🙃

Foi utilizada a lista de todas as palavras do português brasileiro disponibilizada publicamente pelo IME-USP para compor a base de dados dessa aplicação.

Documentação da API

Todos os endpoints retornam um JSON com os dados no seguinte formato:

{
    _id: string (ObjectId),
    position: string,
    word: string,
    length: string,
}

Retorna uma palavra aleatória.

    GET /word/random

Retorna uma palavra aleatória com número de caracteres específico.

    GET /word/:length/random

Parâmetro	Tipo	Descrição
length	string	Obrigatório. Quantidade de caracteres que a palavra deve possuir.

Retorna a palavra que está em uma posição específica da lista.

    GET /word/position/:position

Parâmetro	Tipo	Descrição
position	string	Obrigatório. Posição de 1 a N.

Rodando localmente

Instale as dependências

  npm install

Inicie o servidor

  npm run dev

Crie o arquivo .env na raiz do projeto para armazenar as variáveis de ambiente:

PORT

MONGODB_URL

MONGODB_USERNAME

MONGODB_PASSWORD

MONGODB_DATABASE

MONGODB_COLLECTION

FILE_PATH (necessário para inserir os dados no banco, caminho do arquivo .txt)

Iserção das palavras no banco

Utilize a função wordsInsertion que está no diretório /utils.