Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kreig303/omdb-bot
Finds film details on IMDB via the OMDB API.
https://github.com/kreig303/omdb-bot
hapi imdb omdb rest-api restful-api
Last synced: 4 months ago
JSON representation
Finds film details on IMDB via the OMDB API.
- Host: GitHub
- URL: https://github.com/kreig303/omdb-bot
- Owner: kreig303
- License: other
- Created: 2019-04-05T19:09:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-19T17:18:19.000Z (about 1 year ago)
- Last Synced: 2024-10-17T02:48:25.906Z (4 months ago)
- Topics: hapi, imdb, omdb, rest-api, restful-api
- Language: JavaScript
- Homepage: https://omdb-bot.herokuapp.com
- Size: 544 KB
- Stars: 4
- Watchers: 1
- Forks: 43
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# omdb-bot
[](http://travis-ci.com/kreig303/omdb-bot)
[](https://snyk.io/test/github/kreig303/omdb-bot?targetFile=package.json)
[](https://david-dm.org/kreig303/omdb-bot)
[](https://david-dm.org/kreig303/omdb-bot?type=dev)
Finds film details on IMDB via the OMDB API.
## Prerequisites
1. [git](https://git-scm.com/downloads).
2. [Node 12+](https://nodejs.org/en/download/).
3. [Docker Desktop](https://www.docker.com/products/developer-tools)
## Installation
```sh
% git clone https://github.com/kreig303/omdb-bot.git
% cd omdb-bot
% npm it
```
## Configuration
1. [Register for an OMDB API key](https://www.omdbapi.com/).
2. Create a `.env` file at the root of the app directory
3. Configure `.env` as follows. Port 8000 is my default. [YMMV](https://dictionary.cambridge.org/us/dictionary/english/ymmv).
```env
PORT=8000
BOT_KEY=abcdefg
```
## Usage
### Develop
```sh
% npm run start:dev
```
### Run
#### Docker
```sh
% docker-compose build
% docker-compose up
```
#### CLI
```sh
% npm start
```
### Endpoints
1. ```/api/movie/[title of film]``` (gets movie info)
2. ```/api/poster/[imdb id for film]``` (gets movie poster)
## History
[Discover the release history by heading on over to the releases page.](https://github.com/kreig303/omdb-bot/releases)
## Contribute
These amazing people have contributed code to this project:
- [Kreig Zimmerman](https://github.com/kreig303) — [view contributions](https://github.com/kreig303/omdb-bot/commits?author=kreig303)
[Discover how you can contribute by heading on over to the CONTRIBUTING.md file.](https://github.com/kreig303/omdb-bot/blob/master/CONTRIBUTING.md#files)
## License
Unless stated otherwise all works are:
- Copyright © 2019-2020 [Kreig Zimmerman](https://github.com/kreig303)
and licensed under:
- [MIT License](http://spdx.org/licenses/MIT.html)