adding a example app

Author: jshemas

.eslintignore

@@ -1,3 +1,4 @@
 coverage/
 dist/
 node_modules/
+example/

README.md

@@ -133,3 +133,7 @@ ogs({ url: 'https://www.wikipedia.org/', fetchOptions: { headers: { 'user-agent'
     console.log('response:', response); // This contains response from the Fetch API
   })
 ```
+
+## Running the example app
+
+Inside the `example` folder contains a simple express app where you can run `npm ci && npm run start` to spin up. Once the app is running, open a web browser and go to `http://localhost:3000/scraper?url=http://ogp.me/` to test it out. There is also a `Dockerfile` if you want to run this example app in a docker container.

example/Dockerfile

@@ -0,0 +1,16 @@
+# docker build -t open-graph-scraper .
+# docker run -dp 127.0.0.1:3000:3000 open-graph-scraper
+# http://127.0.0.1:3000/scraper?url=http://ogp.me/
+FROM node:20
+
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+EXPOSE 3000
+
+CMD [ "node", "index.js" ]

example/index.js

@@ -0,0 +1,20 @@
+const express = require('express');
+const ogs = require('open-graph-scraper');
+const app = express();
+const port = 3000;
+
+// http://localhost:3000/scraper?url=http://ogp.me/
+app.get('/scraper', async (req, res) => {
+  if (!req.query.url) return res.send('Missing url query!');
+  const options = { url: req.query.url };
+  try {
+    const data = await ogs(options);
+    res.send(data); 
+  } catch (error) {
+    res.send(error);
+  }
+});
+
+app.listen(port, () => {
+  console.log(`Example open-graph-scraper app listening on port ${port}`);
+});