feat: added git enabled data backup and usage as template instructions

Author: 0-vortex

README.md

@@ -2,10 +2,18 @@
 
 [![Commitizen Friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
  [![License](https://img.shields.io/github/license/0-vortex/workers-url-shortener)](./LICENSE)
+ [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2F0-vortex%2Fworkers-url-shortener.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2F0-vortex%2Fworkers-url-shortener?ref=badge_shield)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/26ea74df7c6fe2f18438/maintainability)](https://codeclimate.com/github/0-vortex/workers-url-shortener/maintainability)
+ [![Known Vulnerabilities](https://snyk.io/test/github/0-vortex/workers-url-shortener/badge.svg)](https://snyk.io/test/github/0-vortex/workers-url-shortener)
 
 ## Overview
 
-TBD 
+A Cloudflare Workers script to use as a simple redirect system.
+
+The [data.json](./src/data.json) file can be used as dummy input or ``git`` enabled backup for your production environment.
+
+The motivation for doing such a thing is GUI or IAM enabled acces to these variables from other CloudFlare tools, essentially promoting observability.
 
 ## Folder structure
 
@@ -88,6 +96,46 @@ gh repo clone  0-vortex/workers-url-shortener
 
 ## Usage
 
+### Configure KV
+
+To successfully run the redirect worker we need to set up some KV namespaces.
+
+Generate new `namespace_id`s for the KV keys it [wrangler.toml](./wrangler.toml) and follow the instructions:
+
+```shell
+# dev environment
+wrangler kv:namespace create "REDIRECTS"
+wrangler kv:namespace create "REDIRECTS" --preview
+```
+
+```shell
+# production environment
+wrangler kv:namespace create "REDIRECTS" --env production
+wrangler kv:namespace create "REDIRECTS" --env production --preview
+```
+
+After you are done editing check if the changes are correct:
+
+```shell
+wrangler kv:namespace list
+```
+
+### Test data
+
+Upload some data to the ``REDIRECTS`` namespace:
+
+```shell
+# dev environment
+wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json
+wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json --preview
+```
+
+```shell
+# production environment
+wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json --env production
+wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json --env production --preview
+```
+
 ### Local development
 
 To develop locally just run:
@@ -113,3 +161,5 @@ wrangler tail
 ## License
 
 This library is released under BSD-3 license clause.
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2F0-vortex%2Fworkers-url-shortener.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2F0-vortex%2Fworkers-url-shortener?ref=badge_large)

src/data.json

@@ -0,0 +1,42 @@
+[
+  {
+    "key": "lastfm",
+    "value": "https://www.last.fm/user/zero-vortex"
+  },
+  {
+    "key": "soundcloud",
+    "value": "https://soundcloud.com/vorteks"
+  },
+  {
+    "key": "twitter",
+    "value": "https://twitter.com/0_vortex"
+  },
+  {
+    "key": "angel",
+    "value": "https://angel.co/u/vortex-1"
+  },
+  {
+    "key": "bitbucket",
+    "value": "https://bitbucket.org/tedvortex"
+  },
+  {
+    "key": "crunchbase",
+    "value": "https://www.crunchbase.com/person/ted-vortex"
+  },
+  {
+    "key": "github",
+    "value": "https://github.com/0-vortex"
+  },
+  {
+    "key": "linkedin",
+    "value": "https://uk.linkedin.com/in/tedvortex"
+  },
+  {
+    "key": "stackoverflow",
+    "value": "http://stackoverflow.com/users/757375/vortex"
+  },
+  {
+    "key": "stackshare",
+    "value": "https://stackshare.io/0_vortex"
+  }
+]

src/index.js

@@ -8,7 +8,7 @@ const handleRequest = async request => {
 
       if (key !== '') {
         // eslint-disable-next-line
-        const redirectTo = new URL(await VORTEX_DOT_NAME.get(key));
+        const redirectTo = new URL(await REDIRECTS.get(key));
 
         if (redirectTo) {
           return Response.redirect(redirectTo, 301);

wrangler.toml

@@ -4,7 +4,7 @@ account_id = "4ae2b0231430be3b4de63e32381d6513"
 zone_id = "af76b9090f6e819df8e36ba0d850b2fd"
 workers_dev = true
 kv_namespaces = [
-  { binding = "VORTEX_DOT_NAME", id = "0b8f93760c244cad97f10a6ab2cad9bb", preview_id = "8f35599f4d424d78b68117e8ed82dbed" }
+  { binding = "REDIRECTS", id = "a440b997322e4f74b64de848dee1d149", preview_id = "22e9d18085d44c049a481035df41c5b1" }
 ]
 
 [dev]
@@ -18,5 +18,5 @@ name = "url-shortener"
 workers_dev = false
 route = "get-social-with.vortex.name"
 kv_namespaces = [
-  { binding = "VORTEX_DOT_NAME", id = "bee089bc49d342bfb9b019dbffc3e415", preview_id = "6d3f646d985d469685dbc306051951ab" }
+  { binding = "REDIRECTS", id = "d6444b81e4be4991af05e9cbbe0b48f1", preview_id = "6a76c5899d914da5851e6f31a074692a" }
 ]