Merge pull request #158 from aliansoftwareteam/feature/one-command-dev-setup

feat(setup): one-command developer setup via npm run setup

Author: parth0025

.env.example

@@ -1,3 +1,11 @@
+# ─────────────────────────────────────────
+# QUICK START
+# Run `npm run setup` — it copies this file to .env and auto-fills:
+#   JWT_SECRET, PRECOMPANYKEY  (random secure values)
+#   STORAGE_TYPE               (set to "server" — no cloud storage needed for local dev)
+# Everything else can be configured interactively via the installation wizard.
+# ─────────────────────────────────────────
+
 # ─────────────────────────────────────────
 # SERVER
 # ─────────────────────────────────────────
@@ -10,6 +18,7 @@ UNDER_MAINTENANCE="false"                  # true | false
 # DATABASE
 # ─────────────────────────────────────────
 MONGODB_URL="mongodb://localhost:27017"    # REQUIRED — mongo connection string (no trailing slash)
+MONGO_CLOUD_URL="https://cloud.mongodb.com/api"
 
 # ─────────────────────────────────────────
 # AUTH / JWT
@@ -46,7 +55,7 @@ WEBURL="http://localhost:4000"
 # addition to WEBURL / APIURL. Use this for multi-domain deployments
 # (e.g. a staging frontend on a separate host). Leave blank in single-
 # domain setups.
-CORS_ORIGINS=""
+CORS_ORIGINS="http://localhost:8080"
 
 # ─────────────────────────────────────────
 # STORAGE
@@ -89,7 +98,7 @@ RESEND_FROM_EMAIL="onboarding@resend.dev" # Use verified domain in production
 # FIREBASE (push notifications)
 # Leave blank to disable push notifications
 # ─────────────────────────────────────────
-SERVICE_FILE="../firebase-adminsdk.json"  # Path to Firebase service account JSON
+SERVICE_FILE="./firebase-adminsdk.json"   # Path to Firebase service account JSON (must be inside project root)
 APIKEY=""
 AUTODOMAIN=""
 PROJECTID=""
@@ -105,8 +114,8 @@ MEASUREMENTID=""
 # Username is plain text. Password must be a bcrypt hash — generate with:
 #   node -e "console.log(require('bcrypt').hashSync(process.argv[1], 12))" '<your-password>'
 # ─────────────────────────────────────────
-SOCKETIO_ADMIN_USERNAME=""
-SOCKETIO_ADMIN_PASSWORD_HASH=""
+SOCKETIO_ADMIN_USERNAME="alian"
+SOCKETIO_ADMIN_PASSWORD_HASH="$2a$12$HHemhzmTrC8Dmf2Gd9v/Teo9oiCxfYJb.St3HKMBx1L3wJmZLeX5u"
 
 # ─────────────────────────────────────────
 # AI

Modules/CheckInstallStep/controller.js

@@ -17,10 +17,14 @@ const { makeUniqueId } = require('../../utils/commonFunctions.js');
 // BUG-036 / #90 — path-traversal-safe resolver for the firebase service-account file.
 const { resolveServiceFile } = require('../../utils/safeServiceFile.js');
 
+// Evaluated at module-load time: fall back to the documented default when APIURL
+// isn't set yet (fresh clone, partially-edited .env, or this file getting required
+// before dotenv has run). Preserves the original "strip trailing slash" behaviour.
+const __defaultApiUrl = process.env.APIURL || 'http://localhost:4000/';
 exports.envVar = {
     "JWT_SECRET": require('crypto').randomBytes(16).toString('hex'),
     "PRECOMPANYKEY": require('crypto').randomBytes(4).toString('hex'),
-    "WEBURL": `${process.env.APIURL.substring(0, process.env.APIURL.length - 1)}`, // Static discussion
+    "WEBURL": __defaultApiUrl.substring(0, __defaultApiUrl.length - 1),
 }
 
 exports.tmpInstallSteps = [{
@@ -693,6 +697,26 @@ exports.checkinstallstep = (req, res) => {
         }
 
         if (bodyData.step === 4) {
+            // Allow Firebase to be skipped (push notifications are optional for self-hosted dev).
+            // Matches the existing isDoItLater pattern used for the AI step.
+            if (bodyData.isDoItLater) {
+                exports.installSteps[3].status = "done";
+                exports.envVar.APIKEY = "";
+                exports.envVar.AUTODOMAIN = "";
+                exports.envVar.PROJECTID = "";
+                exports.envVar.STORAGEBUCKET = "";
+                exports.envVar.MESSAGINGSENDERID = "";
+                exports.envVar.APPID = "";
+                exports.envVar.MEASUREMENTID = "";
+                serviceFun.writeFile(installStepsFilePath, JSON.stringify({installSteps: exports.installSteps, envVar: exports.envVar}, null, 4), () => {
+                    setTimeout(() => { emitListener(bodyData?.eventId, {step: 1}); }, 1000);
+                    setTimeout(() => {
+                        emitListener(bodyData?.eventId, {step: "STOP"});
+                        res.json({ status: true, statusText: "Firebase skipped", step: 4 });
+                    }, 2000);
+                });
+                return;
+            }
             exports.installSteps[3].status = "inprogress";
             serviceFun.writeFile(installStepsFilePath, JSON.stringify({installSteps: exports.installSteps, envVar: exports.envVar}, null, 4), () => {
                 exports.checkFirebaseConnection(req, (firebaseRes) => {
@@ -760,6 +784,19 @@ exports.checkinstallstep = (req, res) => {
         }
 
         if (bodyData.step === 6) {
+            // Allow SMTP to be skipped (email is optional for first-run dev — operator can
+            // configure it later from the admin UI). Matches the AI/Firebase skip pattern.
+            if (bodyData.isDoItLater) {
+                exports.installSteps[5].status = "done";
+                serviceFun.writeFile(installStepsFilePath, JSON.stringify({installSteps: exports.installSteps, envVar: exports.envVar}, null, 4), () => {
+                    setTimeout(() => { emitListener(bodyData?.eventId, {step: 1}); }, 1000);
+                    setTimeout(() => {
+                        emitListener(bodyData?.eventId, {step: "STOP"});
+                        res.json({ status: true, statusText: "SMTP skipped", step: 6 });
+                    }, 2000);
+                });
+                return;
+            }
             exports.installSteps[5].status = "inprogress";
             serviceFun.writeFile(installStepsFilePath, JSON.stringify({installSteps: exports.installSteps, envVar: exports.envVar}, null, 4), () => {
                 if (bodyData.key === 1) {

README.md

@@ -41,6 +41,63 @@ Built for enterprises, startups, and growing teams — without vendor lock-in.
 
 ---
 
+## Quick Start (One Command)
+
+```bash
+git clone https://github.com/aliansoftwareteam/AlianHub-Project-Management-System.git
+cd AlianHub-Project-Management-System
+npm run setup
+```
+
+That's it. **No technical knowledge required.** `npm run setup` will:
+
+1. Install all dependencies (root, frontend, wizard) in parallel
+2. Generate a `.env` file with secure random secrets
+3. Build the installation wizard UI
+4. Start the backend and frontend dev server
+5. **Auto-complete the installation wizard** — connects to MongoDB, sets up storage, skips optional services (Firebase / AI / SMTP), initializes the database, and creates an admin account
+6. Open `http://localhost:8080` in your browser
+
+When it's done, you'll see this in your terminal:
+
+```
+──────────────────────────────────────────────────────────
+  ✓  AlianHub is ready!
+──────────────────────────────────────────────────────────
+
+  URL:       http://localhost:8080
+  Email:     admin@admin.local
+  Password:  admin123
+
+  API:       http://localhost:4000
+  Stop:      Ctrl+C in this terminal
+──────────────────────────────────────────────────────────
+```
+
+**Prerequisite:** MongoDB running locally on `mongodb://localhost:27017`. If you don't have it: `docker run -d -p 27017:27017 mongo:7` or download from [mongodb.com](https://www.mongodb.com/try/download/community).
+
+### Available commands
+
+| Command | What it does |
+|---------|--------------|
+| `npm run setup` | Full setup — install, configure, start, auto-complete wizard, open browser |
+| `npm run dev` | Fast restart — skips install, just starts the services |
+| `npm run setup:reset` | Wipe `node_modules` and reinstall everything |
+| `npm run setup -- --manual` | Skip auto-setup — open the interactive wizard instead |
+| `npm run setup -- --no-open` | Start without auto-opening a browser |
+
+### Custom admin credentials
+
+```bash
+SETUP_ADMIN_EMAIL=you@example.com SETUP_ADMIN_PASSWORD=secret npm run setup
+```
+
+Other env-var overrides: `SETUP_ADMIN_FIRST`, `SETUP_ADMIN_LAST`, `SETUP_COMPANY`, `SETUP_PHONE`, `SETUP_COUNTRY`, `SETUP_CITY`, `SETUP_STATE`.
+
+> **Manual setup still works.** Everything above is an additive convenience layer. All existing scripts (`npm start`, `npm run nodemon`, `npm run basic-install`, etc.) and the original interactive wizard are unchanged. If `npm run setup` ever fails it falls back automatically to the wizard UI so you can finish manually.
+
+---
+
 ## What is AlianHub?
 
 **AlianHub** is a full-stack, open-source project management system designed for teams that require flexibility, transparency, and ownership over their workflows.

nodemon.json

@@ -0,0 +1,22 @@
+{
+  "watch": [
+    "Config",
+    "Modules",
+    "common-storage",
+    "event",
+    "middlewares",
+    "socket",
+    "utils",
+    "index.js",
+    "server.js",
+    "cron.js"
+  ],
+  "ext": "js,mjs,cjs",
+  "ignore": [
+    "node_modules",
+    "tests",
+    "**/*.test.js",
+    "**/*.spec.js"
+  ],
+  "delay": 1500
+}

package.json

@@ -47,11 +47,15 @@
     "start": "node server.js",
     "nodemon": "nodemon index.js",
     "check-version": "node check-version.js",
-    "basic-install": "node installation.js && npm run start"
+    "basic-install": "node installation.js && npm run start",
+    "setup": "node scripts/dev.js",
+    "dev": "node scripts/dev.js --skip-install",
+    "setup:reset": "node scripts/dev.js --force"
   },
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "jest": "^30.4.2"
+    "jest": "^30.4.2",
+    "nodemon": "^3.1.0"
   }
 }