This script automates the setup of a starter Node.js project with Express, session management, and authentication scaffolding. It creates the directory and file structure, installs necessary dependencies, sets up npm scripts, and provides usage instructions for both Unix-like and Windows environments.
-
Sets Up Folders & Files Creates directories under
src/for routing, configuration, controllers, middlewares, and models. Creates placeholder files:src/config/db.js src/controller/auth.js src/middlewares/admin.js src/model/Auth.js src/router/auth.routes.js src/server.js -
Initializes npm Project Runs
npm init -yto generate apackage.jsonwith default values. -
Installs Dependencies
- Runtime:
dotenv,express,express-session,express-validator,jsonwebtoken,mysql2 - Dev:
nodemon
- Runtime:
-
Configures Package Scripts Uses
npm pkg setto updatepackage.jsonwith:{ "name": "new", "type": "module", "scripts": { "dev": "nodemon src/server.js" } }
# First time only:
chmod +x node-project-launcher.sh
# Scaffold the project:
./node-project-launcher.sh# No chmod step needed. Run directly with bash:
bash node-project-launcher.sh