Skip to content

mldictionary/MLDictionaryAPI

Repository files navigation

icon

MLDictionary API

ACCESS WORDS' DEFINITIONS

GitHub stars


⚈ About

A Flask API to access words' definitions

language options: English, Portuguese and Spanish


⚈ Required

This application uses Docker and Docker Compose, to install access the links bellow.


⚈ How to use

[example@example]$ git clone https://github.com/mldictionary/MLDictionaryAPI
[example@example]$ cd MLDictionaryAPI
[example@example MLDictionaryAPI]$ docker-compose up -d
[example@example MLDictionaryAPI]$ URL="http://127.0.0.1:8088"; xdg-open $URL || sensible-browser $URL || x-www-browser $URL || gnome-open $URL

Documentation

Proper documentation can be find in extern deploy or using the local docker deploy in your machine.


⚈ Tech Stack

The following tools were used in the construction of the project:


⚈ Tree Directory

.
├── mldictionary_api
│   ├── models
│   │   ├── __init__.py
│   │   ├── base.py
│   │   ├── const.py
│   │   ├── meanings.py
│   │   └── requests.py
│   ├── resources
│   │   ├── __init__.py
│   │   ├── const.py
│   │   ├── response.py
│   │   └── translator.py
│   ├── routes
│   │   ├── __init__.py
│   │   ├── api.py
│   │   └── views.py
│   ├── static
│   │   ├── css
│   │   │   ├── small_screen.css
│   │   │   └── style.css
│   │   └── js
│   │       └── scripts.js
│   ├── templates
│   │   └── index.jinja2
│   ├── __init__.py
│   ├── app.py
│   └── const.py
├── Dockerfile
├── LICENSE
├── Procfile
├── README.md
├── docker-compose.yml
└── requirements.txt

8 directories, 25 files

⚈ Bugs and Features

Please report any type of bug. Remember that this is an open source project and will evolve with everyone's help. :)
Any report will be read and will get due attention


New features are being done and new ideas are being created always that possible...
new ideas will be accepted...