create-bus-project 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Umwali Christa
+
+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.

package/PUBLISHING.md

@@ -0,0 +1,35 @@
+# Publishing `create-bus-project` to npm
+
+1. Create or log in to your npm account:
+
+```bash
+npm login
+```
+
+2. From this package folder, test the package locally:
+
+```bash
+npm pack
+npm install -g ./create-bus-project-1.0.0.tgz
+create-bus-project
+```
+
+3. Check the package name is available:
+
+```bash
+npm view create-bus-project
+```
+
+If npm returns a 404, the name is available. If it already exists, rename the package in `package.json`, for example `@your-username/create-bus-project`.
+
+4. Publish:
+
+```bash
+npm publish --access public
+```
+
+5. Use it after publishing:
+
+```bash
+npx create-bus-project
+```

package/README.md

@@ -0,0 +1,51 @@
+# create-bus-project
+
+Create a full-stack Bus Booking System with React + Vite frontend, Express backend, and MySQL.
+
+## Usage
+
+```bash
+npx create-bus-project
+```
+
+The CLI asks for:
+
+- Project name
+- Backend port
+- Frontend port
+- MySQL database name
+
+## Generated app
+
+```text
+my-bus-app/
+├── backend/
+│   ├── config/
+│   ├── controllers/
+│   ├── routes/
+│   ├── seeders/
+│   ├── schema.sql
+│   ├── .env
+│   └── package.json
+└── frontend/
+    ├── src/
+    ├── .env
+    ├── vite.config.js
+    └── package.json
+```
+
+## Run generated project
+
+```bash
+cd my-bus-app/backend
+npm install
+mysql -u root -p < schema.sql
+npm run seed
+npm run dev
+```
+
+```bash
+cd my-bus-app/frontend
+npm install
+npm run dev
+```

package/bin/create-bus-project.js

@@ -0,0 +1,113 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import readline from "node:readline/promises";
+import { stdin as input, stdout as output } from "node:process";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageRoot = path.resolve(__dirname, "..");
+const templateDir = path.join(packageRoot, "template");
+
+const pipedAnswers = !process.stdin.isTTY ? fs.readFileSync(0, "utf8").split(/\r?\n/) : [];
+let pipedIndex = 0;
+const rl = process.stdin.isTTY ? readline.createInterface({ input, output }) : null;
+
+const slugify = (value) =>
+  value
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9-_]+/g, "-")
+    .replace(/^-+|-+$/g, "") || "bus-project";
+
+const sanitizeDbName = (value) =>
+  value.trim().replace(/[^a-zA-Z0-9_]/g, "_") || "bus_booking";
+
+const ask = async (question, defaultValue, validator) => {
+  while (true) {
+    const raw = rl
+      ? await rl.question(`${question} (${defaultValue}): `)
+      : (pipedAnswers[pipedIndex++] ?? "");
+    const answer = raw.trim() || defaultValue;
+    if (!validator || validator(answer)) return answer;
+    console.log("Please enter a valid value.");
+  }
+};
+
+const copyRecursive = (source, destination) => {
+  const stat = fs.statSync(source);
+  if (stat.isDirectory()) {
+    fs.mkdirSync(destination, { recursive: true });
+    for (const item of fs.readdirSync(source)) {
+      copyRecursive(path.join(source, item), path.join(destination, item));
+    }
+    return;
+  }
+  fs.copyFileSync(source, destination);
+};
+
+const replaceInFiles = (dir, replacements) => {
+  for (const item of fs.readdirSync(dir)) {
+    const fullPath = path.join(dir, item);
+    const stat = fs.statSync(fullPath);
+    if (stat.isDirectory()) {
+      replaceInFiles(fullPath, replacements);
+      continue;
+    }
+    const binaryExt = new Set([".png", ".jpg", ".jpeg", ".gif", ".ico", ".pdf", ".zip"]);
+    if (binaryExt.has(path.extname(fullPath).toLowerCase())) continue;
+    let content = fs.readFileSync(fullPath, "utf8");
+    for (const [key, value] of Object.entries(replacements)) {
+      content = content.split(key).join(value);
+    }
+    fs.writeFileSync(fullPath, content);
+  }
+};
+
+const main = async () => {
+  console.log("\nCreate Bus Project\n");
+
+  const defaultProjectName = process.argv[2] ? slugify(process.argv[2]) : "bus-project";
+  const projectName = slugify(await ask("Project name", defaultProjectName));
+  const backendPort = await ask("Backend port", "5000", (v) => /^\d+$/.test(v));
+  const frontendPort = await ask("Frontend port", "5173", (v) => /^\d+$/.test(v));
+  const dbName = sanitizeDbName(await ask("MySQL database name", "bus_booking"));
+
+  const destination = path.resolve(process.cwd(), projectName);
+  if (fs.existsSync(destination) && fs.readdirSync(destination).length > 0) {
+    console.error(`\nCannot create project. Folder already exists and is not empty: ${destination}`);
+    process.exit(1);
+  }
+
+  copyRecursive(templateDir, destination);
+
+  replaceInFiles(destination, {
+    "__PROJECT_NAME__": projectName,
+    "__PROJECT_TITLE__": projectName.replace(/-/g, " ").replace(/\b\w/g, (c) => c.toUpperCase()),
+    "__BACKEND_PORT__": backendPort,
+    "__FRONTEND_PORT__": frontendPort,
+    "__DB_NAME__": dbName
+  });
+
+  console.log(`\nSuccess! Created ${projectName}.`);
+  console.log("\nNext steps:");
+  console.log(`  cd ${projectName}/backend`);
+  console.log("  npm install");
+  console.log(`  mysql -u root -p < schema.sql`);
+  console.log("  npm run seed");
+  console.log("  npm run dev");
+  console.log("\nIn a second terminal:");
+  console.log(`  cd ${projectName}/frontend`);
+  console.log("  npm install");
+  console.log("  npm run dev");
+  console.log(`\nFrontend: http://localhost:${frontendPort}`);
+  console.log(`Backend:  http://localhost:${backendPort}\n`);
+};
+
+main()
+  .catch((error) => {
+    console.error(error);
+    process.exit(1);
+  })
+  .finally(() => rl?.close());

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "create-bus-project",
+  "version": "1.0.0",
+  "description": "CLI generator for a full-stack Bus Booking System using React, Vite, Express, and MySQL.",
+  "type": "module",
+  "bin": {
+    "create-bus-project": "bin/create-bus-project.js"
+  },
+  "files": [
+    "bin",
+    "template",
+    "README.md",
+    "PUBLISHING.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "bus",
+    "booking",
+    "react",
+    "vite",
+    "express",
+    "mysql",
+    "starter",
+    "scaffold"
+  ],
+  "author": "Umwali Christa",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  }
+}

package/template/README.md

@@ -0,0 +1,35 @@
+# __PROJECT_TITLE__
+
+Full-stack Bus Booking System generated with `create-bus-project`.
+
+## Included
+- React + Vite frontend
+- Node.js + Express backend
+- MySQL database schema
+- Manager and passenger workflows
+
+## Setup
+
+```bash
+cd backend
+npm install
+cp .env.example .env
+# create the database in MySQL, then import schema.sql
+npm run seed
+npm run dev
+```
+
+Open a second terminal:
+
+```bash
+cd frontend
+npm install
+npm run dev
+```
+
+Backend: http://localhost:__BACKEND_PORT__
+Frontend: http://localhost:__FRONTEND_PORT__
+Database: `__DB_NAME__`
+
+## Default users
+Run `npm run seed` in the backend folder to create starter users.

package/template/backend/.env

@@ -0,0 +1,8 @@
+PORT=__BACKEND_PORT__
+FRONTEND_URL=http://localhost:__FRONTEND_PORT__
+DB_HOST=localhost
+DB_USER=root
+DB_PASSWORD=
+DB_NAME=__DB_NAME__
+SESSION_SECRET=change_this_secret
+NODE_ENV=development

package/template/backend/.env.example

@@ -0,0 +1,8 @@
+PORT=__BACKEND_PORT__
+FRONTEND_URL=http://localhost:__FRONTEND_PORT__
+DB_HOST=localhost
+DB_USER=root
+DB_PASSWORD=
+DB_NAME=__DB_NAME__
+SESSION_SECRET=change_this_secret
+NODE_ENV=development

package/template/backend/README.md

@@ -0,0 +1,29 @@
+# Backend Project
+
+## Steps
+
+1. Open MySQL Workbench or phpMyAdmin.
+2. Run `schema.sql`.
+3. Install dependencies:
+
+```bash
+npm install
+```
+
+4. Seed users:
+
+```bash
+npm run seed
+```
+
+5. Start backend:
+
+```bash
+npm start
+```
+
+Default users:
+
+- manager1 / 123456
+- driver1 / 123456
+- passenger1 / 123456

package/template/backend/config/db.js

@@ -0,0 +1,21 @@
+import mysql from "mysql2";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const db = mysql.createConnection({
+  host: process.env.DB_HOST || "localhost",
+  user: process.env.DB_USER || "root",
+  password: process.env.DB_PASSWORD || "",
+  database: process.env.DB_NAME || "__DB_NAME__"
+});
+
+db.connect((err) => {
+  if (err) {
+    console.log("Database connection failed:", err.message);
+  } else {
+    console.log("Database connected successfully");
+  }
+});
+
+export default db;

package/template/backend/controllers/authController.js

@@ -0,0 +1,109 @@
+import bcrypt from "bcryptjs";
+import db from "../config/db.js";
+
+export const register = async (req, res) => {
+  const { username, password, userRole } = req.body;
+
+  if (!username || !password || !userRole) {
+    return res.status(400).json({
+      message: "Username and password  are required"
+    });
+  }
+
+  const allowedRoles = ["passenger", "manager"];
+
+  if (!allowedRoles.includes(userRole)) {
+    return res.status(400).json({
+      message: "Only passenger and manager registration is allowed"
+    });
+  }
+
+  const checkSql = "SELECT * FROM yk_users WHERE username=?";
+
+  db.query(checkSql, [username], async (err, result) => {
+    if (err) return res.status(500).json(err);
+
+    if (result.length > 0) {
+      return res.status(409).json({
+        message: "Username already exists"
+      });
+    }
+
+    const hashedPassword = await bcrypt.hash(password, 10);
+
+    const sql = `
+      INSERT INTO yk_users(username, password, userRole)
+      VALUES(?,?,?)
+    `;
+
+    db.query(sql, [username, hashedPassword, userRole], (err, result) => {
+      if (err) return res.status(500).json(err);
+
+      res.status(201).json({
+        message: `${userRole} registered successfully`,
+        userid: result.insertId
+      });
+    });
+  });
+};
+
+export const login = (req, res) => {
+  const { username, password, userRole } = req.body;
+
+  if (!username || !password || !userRole) {
+    return res.status(400).json({
+      message: "Username and password  are required"
+    });
+  }
+
+  const sql = "SELECT * FROM yk_users WHERE username=? AND userRole=?";
+
+  db.query(sql, [username, userRole], async (err, result) => {
+    if (err) return res.status(500).json(err);
+
+    if (result.length === 0) {
+      return res.status(404).json({
+        message: `No ${userRole} account found with that username`
+      });
+    }
+
+    const user = result[0];
+
+    const isMatch = await bcrypt.compare(password, user.password);
+
+    if (!isMatch) {
+      return res.status(400).json({
+        message: "Wrong password"
+      });
+    }
+
+    req.session.user = {
+      userid: user.userid,
+      username: user.username,
+      userRole: user.userRole
+    };
+
+    res.json({
+      message: "Login successful",
+      user: req.session.user
+    });
+  });
+};
+
+export const logout = (req, res) => {
+  req.session.destroy(() => {
+    res.json({
+      message: "Logged out successfully"
+    });
+  });
+};
+
+export const me = (req, res) => {
+  if (!req.session.user) {
+    return res.status(401).json({
+      message: "Not logged in"
+    });
+  }
+
+  res.json(req.session.user);
+};

package/template/backend/controllers/bookingController.js

@@ -0,0 +1,99 @@
+import db from "../config/db.js";
+
+export const getBookings = (req, res) => {
+  const sql = `SELECT yk_bookings.*, yk_schedules.routename, yk_schedules.departurepoint, yk_schedules.destination FROM yk_bookings INNER JOIN yk_schedules ON yk_bookings.scheduleid = yk_schedules.scheduleid ORDER BY bookingid DESC`;
+
+  db.query(sql, (err, result) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json(result);
+  });
+};
+
+export const getMyBookings = (req, res) => {
+  const { userid } = req.params;
+
+  const sql = `
+    SELECT yk_bookings.*, yk_schedules.routename, yk_schedules.departurepoint, yk_schedules.destination, yk_schedules.departuretime, yk_schedules.ticketprice FROM yk_bookings INNER JOIN yk_schedules ON yk_bookings.scheduleid = yk_schedules.scheduleid WHERE yk_bookings.userid = ? ORDER BY bookingid DESC`;
+
+  db.query(sql, [userid], (err, result) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json(result);
+  });
+};
+
+export const getBookedSeats = (req, res) => {
+  const { scheduleid } = req.params;
+
+  const sql = "SELECT seatnumber FROM yk_bookings WHERE scheduleid=?";
+
+  db.query(sql, [scheduleid], (err, result) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json(result.map((row) => row.seatnumber));
+  });
+};
+
+export const createBooking = (req, res) => {
+  const { scheduleid,userid,passengername,passengergender,passengerphone,seatnumber,paymentstatus} = req.body;
+
+  if (!scheduleid || !userid || !passengername || !passengergender || !passengerphone || !seatnumber) {
+    return res.status(400).json({ message: "All booking fields are required" });
+  }
+
+  const sql = `INSERT INTO yk_bookings(scheduleid, userid, passengername, passengergender, passengerphone, seatnumber, paymentstatus)VALUES(?,?,?,?,?,?,?)`;
+
+  db.query(
+    sql,
+    [scheduleid, userid, passengername, passengergender, passengerphone, seatnumber, paymentstatus || "pending"],
+    (err) => {
+      if (err) {
+        if (err.code === "ER_DUP_ENTRY") {
+          return res.status(409).json({ message: "This seat is already booked. Choose another seat." });
+        }
+        return res.status(500).json(err);
+      }
+
+      res.json({ message: "Booking created successfully" });
+    }
+  );
+};
+
+export const deleteBooking = (req, res) => {
+  const { id } = req.params;
+
+  db.query("DELETE FROM yk_bookings WHERE bookingid=?", [id], (err) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json({ message: "Booking deleted successfully" });
+  });
+};
+
+export const bookingReport = (req, res) => {
+  const sql = `
+    SELECT 
+      yk_schedules.scheduleid,
+      yk_schedules.routename,
+      yk_schedules.departurepoint,
+      yk_schedules.destination,
+      yk_schedules.departuretime,
+      yk_bookings.passengername,
+      yk_bookings.passengergender,
+      yk_bookings.passengerphone,
+      yk_bookings.seatnumber,
+      yk_bookings.paymentstatus
+    FROM yk_bookings
+    INNER JOIN yk_schedules ON yk_bookings.scheduleid = yk_schedules.scheduleid
+    ORDER BY yk_schedules.routename, yk_bookings.seatnumber
+  `;
+
+  db.query(sql, (err, result) => {
+    if (err) return res.status(500).json(err);
+    res.json(result);
+  });
+};

package/template/backend/controllers/busController.js

@@ -0,0 +1,34 @@
+import db from "../config/db.js";
+
+export const getBuses = (req, res) => {
+  db.query("SELECT * FROM yk_buses ORDER BY busid DESC", (err, result) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json(result);
+  });
+};
+
+export const createBus = (req, res) => {
+  const { platenumber, totalseats, bustype } = req.body;
+
+  const sql = "INSERT INTO yk_buses(platenumber, totalseats, bustype) VALUES(?,?,?)";
+
+  db.query(sql, [platenumber, totalseats, bustype], (err) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json({ message: "Bus added successfully" });
+  });
+};
+
+export const deleteBus = (req, res) => {
+  const { id } = req.params;
+
+  db.query("DELETE FROM yk_buses WHERE busid=?", [id], (err) => {
+    if (err) {
+      res.status(500).json(err);
+    } 
+    res.json({ message: "Bus deleted successfully" });
+  });
+};

package/template/backend/controllers/scheduleController.js

@@ -0,0 +1,52 @@
+import db from "../config/db.js";
+
+export const getSchedules = (req, res) => {
+  const sql = `
+    SELECT yk_schedules.*, yk_buses.platenumber, yk_buses.totalseats
+    FROM yk_schedules
+    INNER JOIN yk_buses ON yk_schedules.busid = yk_buses.busid
+    ORDER BY scheduleid DESC
+  `;
+
+  db.query(sql, (err, result) => {
+    if (err) return res.status(500).json(err);
+    res.json(result);
+  });
+};
+
+export const createSchedule = (req, res) => {
+  const {
+    busid,
+    routename,
+    departurepoint,
+    destination,
+    departuretime,
+    estimatedarrivaltime,
+    ticketprice,
+    scheduleStatus
+  } = req.body;
+
+  const sql = `
+    INSERT INTO yk_schedules
+    (busid, routename, departurepoint, destination, departuretime, estimatedarrivaltime, ticketprice, scheduleStatus)
+    VALUES(?,?,?,?,?,?,?,?)
+  `;
+
+  db.query(
+    sql,
+    [busid, routename, departurepoint, destination, departuretime, estimatedarrivaltime, ticketprice, scheduleStatus],
+    (err) => {
+      if (err) return res.status(500).json(err);
+      res.json({ message: "Schedule added successfully" });
+    }
+  );
+};
+
+export const deleteSchedule = (req, res) => {
+  const { id } = req.params;
+
+  db.query("DELETE FROM yk_schedules WHERE scheduleid=?", [id], (err) => {
+    if (err) return res.status(500).json(err);
+    res.json({ message: "Schedule deleted successfully" });
+  });
+};

package/template/backend/controllers/userController.js

@@ -0,0 +1,39 @@
+import bcrypt from "bcryptjs";
+import db from "../config/db.js";
+
+export const getUsers = (req, res) => {
+  const sql = "SELECT userid, username, userRole FROM yk_users ORDER BY userid DESC";
+
+  db.query(sql, (err, result) => {
+    if (err) return res.status(500).json(err);
+    res.json(result);
+  });
+};
+
+export const createUser = async (req, res) => {
+  const { username, password, userRole } = req.body;
+
+  if (!username || !password || !userRole) {
+    return res.status(400).json({ message: "All fields are required" });
+  }
+
+  const hashedPassword = await bcrypt.hash(password, 10);
+
+  const sql = "INSERT INTO yk_users(username, password, userRole) VALUES(?,?,?)";
+
+  db.query(sql, [username, hashedPassword, userRole], (err, result) => {
+    if (err) return res.status(500).json(err);
+
+    res.json({ message: "User created successfully" });
+  });
+};
+
+export const deleteUser = (req, res) => {
+  const { id } = req.params;
+
+  db.query("DELETE FROM yk_users WHERE userid=?", [id], (err) => {
+    if (err) return res.status(500).json(err);
+
+    res.json({ message: "User deleted successfully" });
+  });
+};