Simplinode 🚀

Simplinode is a powerful tool designed to rapidly create a fully functional Node.js MVC backend. It streamlines the setup process, allowing developers to focus on building applications without the hassle of manual configuration.

🚨🚨 IMPORTANT INSTALLATION NOTICE 🚨🚨

READ THIS BEFORE INSTALLING – The installation method depends on your operating system. Using the wrong command may require manual dependency installation, especially on Windows.

macOS & Linux Users ✅

Both commands below will install all required dependencies automatically, and your server will be ready to run immediately:

npx simplinode --install
---
npm install simplinode

Windows Users ⚠️

Both commands below will install all required dependencies automatically, but your server will not be ready to run immediately:

npx simplinode --install
---
npx simplinode my-app --install

Note: If you are using Windows OneDrive or locked folders, always use the npx simplinode --install command to ensure the correct dependencies are installed.

if you are using Windows OneDrive or locked folders, you can use npm install simplinode but you have to install the dependencies manually.

To install dependencies manually, you need to run npm install express dotenv mongoose and npm install -D nodemon.

📦 Quick Start (Recommended)

1. Create a new project in a folder:
   npx simplinode my-app --install
2. Move into the project folder:
   cd my-app
3. Start development mode:
   npm run dev
4. Open your browser at:
   http://localhost:3693/hello → Hello Node.js 👋

🗂 What Gets Created

project/
├── server.js
├── config/
│ └── db.js
├── controllers/
│ └── helloController.js
├── models/
│ └── sampleModel.js
├── routes/
│ └── helloRoutes.js
├── middlewares/
│ └── errorHandler.js
├── utils/
│ └── logger.js
├── .env (from env.example if missing)
└── .gitignore (renamed from gitignore)

• Port: 3693 by default (override with PORT in .env)
• MongoDB: set MONGODB_URI in .env to enable DB connection

🏃 Scripts

• npm run dev → start with nodemon
• npm start → start with node

If no package.json exists, Simplinode will create one and add these scripts automatically.

🛠 CLI Usage (Advanced)

• Copy files only (no installs):
  npx simplinode my-app
• Copy files into current folder:
  npx simplinode .
• Copy files + install express, dotenv, mongoose, nodemon:
  npx simplinode my-app --install

Notes:

• Copy is safe-by-default: existing files are not overwritten
• gitignore is renamed to .gitignore automatically
• If env.example exists and .env is missing, .env is created

🧰 Troubleshooting

• Windows OneDrive or locked folders: Always use npx simplinode --install
• Corporate proxy: Configure npm proxy using:
  npm config set proxy http://your-proxy:port
npm config set https-proxy http://your-proxy:port
• Manual install (if needed):
  npm install express dotenv mongoose
npm install -D nodemon

📄 License

MIT