Skip to content

GhadeerAlhayek/node-project-launcher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

Node Project Launcher Script

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.


What the Script Does

  1. 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
    
  2. Initializes npm Project Runs npm init -y to generate a package.json with default values.

  3. Installs Dependencies

    • Runtime: dotenv, express, express-session, express-validator, jsonwebtoken, mysql2
    • Dev: nodemon
  4. Configures Package Scripts Uses npm pkg set to update package.json with:

    {
      "name": "new",
      "type": "module",
      "scripts": {
        "dev": "nodemon src/server.js"
      }
    }

Usage

macOS / Linux

# First time only:
chmod +x node-project-launcher.sh

# Scaffold the project:
./node-project-launcher.sh

Windows (Git Bash, WSL, Cygwin)

# No chmod step needed. Run directly with bash:
bash node-project-launcher.sh

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages