initial commit

Author: fahad19

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -0,0 +1,16 @@
+node_modules
+lib
+*.log
+coverage
+dist
+out
+
+.DS_Store
+
+npm-debug.log*
+
+.idea
+
+.vscode
+
+.featurevisor

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 100,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Fahad Heylaal (https://fahad19.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# featurevisor-example-expressjs
+
+Example of using [Featurevisor](https://featurevisor.com/) with [Express.js](https://expressjs.com/) application.
+
+# Installation
+
+Clone the repository and install dependencies:
+
+```
+$ npm ci
+```
+
+# Usage
+
+Run the application:
+
+```
+$ npm start
+```
+
+Visit [http://localhost:3000](http://localhost:3000) to see the application.
+
+# License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

index.js

@@ -0,0 +1,63 @@
+const express = require("express");
+const { createInstance } = require("@featurevisor/sdk");
+
+require("isomorphic-fetch");
+
+/**
+ * Constants
+ */
+const PORT = 3000;
+const REFRESH_INTERVAL = 60 * 5; // every 5 minutes
+
+const DATAFILE_URL =
+  process.env.environment === "production"
+    ? "https://featurevisor-example-cloudflare.pages.dev/production/datafile-tag-all.json"
+    : "https://featurevisor-example-cloudflare.pages.dev/staging/datafile-tag-all.json";
+
+/**
+ * Featurevisor instance
+ */
+const f = createInstance({
+  datafileUrl: DATAFILE_URL,
+
+  onReady: () => console.log(`Featurevisor SDK is now ready`),
+  onRefresh: () => console.log(`Featurevisor SDK has refreshed`),
+  onUpdate: () => console.log(`Featurevisor SDK has updates`),
+
+  // optionally refresh the datafile every 5 minutes,
+  // without having to restart the server
+  refreshInterval: REFRESH_INTERVAL,
+});
+
+/**
+ * Express app with middleware
+ */
+const app = express();
+
+app.use((req, res, next) => {
+  req.f = f;
+  next();
+});
+
+/**
+ * Routes
+ */
+app.get("/", (req, res) => {
+  const featureKey = "baz";
+  const context = { userId: "user-123" };
+
+  const isEnabled = f.isEnabled(featureKey, context);
+
+  if (isEnabled) {
+    res.send("Hello World!");
+  } else {
+    res.send("Not enabled yet!");
+  }
+});
+
+/**
+ * Start the server
+ */
+app.listen(PORT, () => {
+  console.log(`Server running at http://localhost:${PORT}`);
+});