From 9af289adbf2b412a75c97912551e8aa9cec7b26b Mon Sep 17 00:00:00 2001 From: BART! Date: Sat, 23 Nov 2024 15:58:37 +0100 Subject: [PATCH] docs(readme): add docker --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 7d9d16b..64c853e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ > - Tested (~100% Code coverage) > - ✅ Ready for new ČSFD 2025! > - You can use in: +> - Docker – [_How to do it?_](#-docker) > - Firebase function > - AWS λ (lambda function) > - CloudFlare Worker @@ -361,6 +362,34 @@ csfd _Note: You can not use both parameters `includesOnly` and `excludes`. Parameter `includesOnly` has a priority._ +## 📦 Docker + +You can use this library in Docker. + +We have [prepared a Docker image](https://hub.docker.com/r/bartholomej/node-csfd-api) for you. + +### Prebuilt image + +```bash +docker pull bartholomej/node-csfd-api +``` + +### Build & run your own image + +> Build image + +```bash +docker build -t node-csfd-api . +``` + +> Run image on port 3000 + +```bash +docker run -p 3000:3000 node-csfd-api +``` + +> Open http://localhost:3000 (`/movies/535121`, `/search/quentin+tarantino`, `/creators/2120`, `/user-ratings/912-bart`, ...) + ## 🧑‍💻 Used by ### Web extensions