Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mldictionary/mldictionaryapi
A Flask API REST to access words' definition
https://github.com/mldictionary/mldictionaryapi
api-rest api-restful backend flask flask-api flask-application flaskapi
Last synced: about 1 month ago
JSON representation
A Flask API REST to access words' definition
- Host: GitHub
- URL: https://github.com/mldictionary/mldictionaryapi
- Owner: mldictionary
- License: mit
- Created: 2021-06-13T20:32:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-23T02:25:08.000Z (over 2 years ago)
- Last Synced: 2023-05-20T22:21:03.992Z (over 1 year ago)
- Topics: api-rest, api-restful, backend, flask, flask-api, flask-application, flaskapi
- Language: Python
- Homepage: https://mldictionaryapi.herokuapp.com/
- Size: 101 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MLDictionary API
ACCESS WORDS' DEFINITIONS
---
# ⚈ 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.
- [Docker](https://docs.docker.com/get-docker/)
- [Docker compose](https://docs.docker.com/compose/install/)
---
# ⚈ 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](https://mldictionaryapi.herokuapp.com/) or using the [local docker deploy](http://127.0.0.1:8088/) in your machine.
---
# ⚈ Tech Stack
The following tools were used in the construction of the project:
- [Python](https://www.python.org/)
- [Flask](https://flask.palletsprojects.com/en/2.0.x/tutorial/)
- [MLDictionary](https://pypi.org/project/mldictionary/)
- [Redis](https://redis.com/)
- [Json](https://www.json.org/json-en.html)
---
# ⚈ Tree Directory
``` bash
.
├── 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...