Convert to package, core functions

Author: faisalnjs

README.md

@@ -2,4 +2,30 @@
 
 Easily plan, manage, and track client commissions.
 
-![Banner](/frontend/public/banner.png)
+![Banner](/frontend/public/banner.png)
+
+## Usage
+
+Include the `commtrackr` package in your Express.js application:
+
+```javascript
+const express = require('express');
+const commtrackr = require('commtrackr'); // Import the commtrackr package
+const app = express();
+app.use('/commtrackr', commtrackr.routes); // Mount routes to /commtrackr path
+commtrackr.init({ // Initialize CommTracker with configurations
+  tenant: {
+    slug: 'commtrackr', // Unique identifier for the tenant
+    name: 'CommTrackr', // Name of the tenant
+    description: 'Easily plan, manage, and track client commissions.', // Description of the tenant
+    auth: {
+      enabled: false, // Enable or disable authentication
+      provider: '', // Recognizable name of authentication provider
+      url: '', // URL to redirect to for authentication
+    },
+  },
+});
+app.listen(3000, () => {
+  console.log('Server is running on http://localhost:3000');
+});
+```

index.js

@@ -0,0 +1,78 @@
+const express = require('express');
+const rateLimit = require('express-rate-limit');
+const cors = require('cors');
+const path = require('path');
+const app = express();
+require('dotenv').config();
+
+app.engine('.ejs', require('ejs').renderFile);
+app.set('view engine', 'ejs');
+app.set('views', path.join(__dirname, 'frontend/pages'));
+app.use(express.static(path.join(__dirname, 'frontend/public'), { redirect: false }));
+app.use(express.urlencoded({ extended: true }));
+app.use(express.json());
+app.use(cors());
+app.use(rateLimit({
+  windowMs: 60 * 1000,
+  max: 15,
+  skip: (req, res) => {
+    return req.ip !== undefined;
+  },
+  message: "Too many requests from this IP, please try again in a minute."
+}));
+
+let on = false;
+let tenant = {};
+let returnHandler = null;
+let user = {};
+
+function init({
+  tenant: newTenant = {
+    slug: 'commtrackr',
+    name: 'CommTrackr',
+    description: 'This is a default tenant configuration.',
+    auth: {
+      enabled: false,
+      provider: '',
+      url: '',
+    },
+  },
+  handler: newHandler = null
+}) {
+  tenant = {
+    slug: 'commtrackr',
+    name: 'CommTrackr',
+    description: 'This is a default tenant configuration.',
+    auth: {
+      enabled: false,
+      provider: '',
+      url: '',
+    },
+    ...newTenant
+  };
+  returnHandler = newHandler;
+};
+
+function activate(isOn = true) {
+  on = isOn;
+  if (!on) user = {};
+};
+
+function setUser(newUser = {}) {
+  if (!newUser.id) return user = {};
+  user = newUser;
+};
+
+app.get('/', async (req, res) => {
+  if (!on) return res.send('Service is not active');
+  if (!tenant.slug) return res.send('No tenant configured');
+  if (tenant.auth && tenant.auth.enabled && !user.id) return res.send('Authentication required');
+  res.send(tenant.slug);
+});
+
+module.exports = {
+  routes: app,
+  init,
+  activate,
+  setUser
+};

package-lock.json

@@ -3,25 +3,36 @@
 	"version": "1.0.0",
 	"description": "Easily plan, manage, and track client commissions.",
 	"main": "index.js",
+	"files": [
+		"index.js",
+		"frontend/"
+	],
 	"scripts": {
 		"start": "node index.js",
 		"dev": "nodemon index.js",
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
-	"keywords": [],
-	"author": "",
+	"keywords": [
+		"commissions",
+		"tracking",
+		"management"
+	],
+	"author": "Dango Web Solutions",
 	"license": "ISC",
 	"dependencies": {
 		"cors": "^2.8.5",
 		"dotenv": "^16.3.1",
 		"ejs": "^3.1.9",
 		"express": "^4.18.2",
 		"express-rate-limit": "^8.0.1",
-		"mysql2": "^3.14.3",
 		"node-fetch": "^3.3.2",
 		"path": "^0.12.7"
 	},
 	"devDependencies": {
 		"nodemon": "^3.0.1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/dangoweb/commtrackr.git"
 	}
 }