Skip to content

Commit 56b8dae

Browse files
committed
docs(readme): add docker
1 parent dc94009 commit 56b8dae

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
> - Tested (~100% Code coverage)
1313
> - ✅ Ready for new ČSFD 2025!
1414
> - You can use in:
15+
> - Docker – [_How to do it?_](#-docker)
1516
> - Firebase function
1617
> - AWS λ (lambda function)
1718
> - CloudFlare Worker
@@ -361,6 +362,43 @@ csfd
361362

362363
_Note: You can not use both parameters `includesOnly` and `excludes`. Parameter `includesOnly` has a priority._
363364

365+
## 📦 Docker
366+
367+
You can use this library in Docker.
368+
369+
We have [prepared a Docker image](https://hub.docker.com/r/bartholomej/node-csfd-api) for you.
370+
371+
### Prebuilt image
372+
373+
```bash
374+
docker pull bartholomej/node-csfd-api
375+
```
376+
377+
### Build & run your own image
378+
379+
> Build image
380+
381+
```bash
382+
docker build -t node-csfd-api .
383+
```
384+
385+
> Run image on port 3000
386+
387+
```bash
388+
docker run -p 3000:3000 node-csfd-api
389+
```
390+
391+
> Open http://localhost:3000
392+
393+
### API endpoints
394+
395+
> Some examples
396+
397+
- `/movies/535121`
398+
- `/search/quentin+tarantino`
399+
- `/creators/2120`
400+
- `/user-ratings/912-bart`
401+
364402
## 🧑‍💻 Used by
365403

366404
### Web extensions

0 commit comments

Comments
 (0)