Skip to content

mldictionary/MLDictionaryAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

127 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

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...