https://github.com/notsu/dict-nodejs
LINE BOT for finding definition and synonyms from Oxford Dictionary.
https://github.com/notsu/dict-nodejs
Last synced: 5 months ago
JSON representation
LINE BOT for finding definition and synonyms from Oxford Dictionary.
- Host: GitHub
- URL: https://github.com/notsu/dict-nodejs
- Owner: notsu
- Created: 2018-05-07T15:17:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T01:10:29.000Z (over 1 year ago)
- Last Synced: 2024-11-19T02:23:59.114Z (over 1 year ago)
- Language: JavaScript
- Size: 2.02 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LINE Dictionary
LINE BOT for finding definition and synonyms from Oxford Dictionary.
## Installation
1. Open LINE application.
2. Scan the following QR code to add bot as your friend
## Usage
- You can type any word and the system will find definition and synonyms for you
## Limitation
- Oxford allow the system to search only 60 keyword per minute and 3000 keyword per month. So, if you exceed that limit the system will notify you back by reply.
- The system allow you search only 10 time per minute. If you prefer to use more than this you can configure `limit` in configuration.
### Contribute
If you need to run this project in your local machine you need to following this step.
#### Prerequisite
- [Docker](https://www.docker.com/get-docker) for virtual environment for local machine.
- [ngrok](https://ngrok.com/) for expose your local machine to public when develop your bot.
#### Local development
1. Copy .env.example to .env
2. Setup your setting in .env
3. Run ngrok in separate terminal during development
4. Run `docker-compose up` at this folder to running docker for local development
PS. `Dockerfile` for deploy to any cloud such as Heroku, AWS, GCP, etc.