Merge branch 'starter-kit'

# Conflicts:
#	README.md
#	package.json

Author: gulalicelik

README.md

@@ -6,11 +6,42 @@ clone this repo and start your project
 ## Installation
 
 ```bash
-npx @gulali/nodejs-express-sequelize-mysql-api-boilerplate my-project-name
+npx @gulali/nodejs-express-sequelize-mysql-api-boilerplate my-project-api
 ```
 
 ## Usage
 
+### Database configuration
+
+edit config/config.json file and change your database name, username and password
+
+```bash
+{
+  "development": {
+    "username": "root",
+    "password": "",
+    "database": "api_db_development",
+    "host": "127.0.0.1",
+    "dialect": "mysql"
+  },
+  "test": {
+    "username": "root",
+    "password": "",
+    "database": "api_db_test",
+    "host": "127.0.0.1",
+    "dialect": "mysql"
+  },
+  "production": {
+    "username": "root",
+    "password": "",
+    "database": "api_db_production",
+    "host": "127.0.0.1",
+    "dialect": "mysql"
+  }
+}
+
+```
+
 ```bash
 npm run start:dev
 ```

bin/cli.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+const { execSync } = require('child_process');
+
+const runCommand = command => {
+    try {
+        execSync(`${command}`, { stdio: 'inherit' });
+    } catch (e) {
+        console.error('Failed to execute ${command}', e);
+        return false;
+    }
+    return true;
+};
+
+const repoName = process.argv[2];
+const gitCheckoutCommand = `git clone --depth 1 https://github.com/gulalicelik/nodejs-express-sequelize-mysql-api-boilerplate.git ${repoName}`;
+const installDepsCommand = `cd ${repoName} && npm install`;
+
+console.log(`Cloning the repository with name ${repoName}`);
+const checkedOut = runCommand(gitCheckoutCommand);
+if (!checkedOut) process.exit(-1);
+
+console.log(`Installing dependencies for ${repoName}`);
+const installedDeps = runCommand(installDepsCommand);
+if (!installedDeps) process.exit(-1);
+
+
+console.log(
+    'Congratulations! You are ready. Follow the following commands to start'
+);
+console.log(`cd ${repoName} && npm start:dev`);

package.json

@@ -1,21 +1,27 @@
 {
-  "name": "nodejs-express-sequelize-mysql-api-boilerplate",
-  "version": "1.0.2",
-  "description": "",
+  "name": "@gulali/nodejs-express-sequelize-mysql-api-boilerplate",
+  "version": "1.0.4",
+  "description": "Nodejs Express Sequelize Mysql API Boilerplate with JWT, Swagger, Winston, PM2",
   "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "prepare": "npx sequelize-cli db:create && npx sequelize-cli db:migrate",
     "start:dev": "pm2 start --env dev",
     "start:test": "pm2 start --env test",
     "start:prod": "pm2 start --env prod",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "bin"       : {
+    "create-nodejs-express-sequelize-mysql-api-boilerplate" : "./bin/cli.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gulalicelik/nodejs-express-sequelize-mysql-api-boilerplate.git"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": ["api", "boilerplate", "nodejs", "express", "sequelize", "mysql", "jwt", "swagger", "winston", "pm2","api-boilerplate","nodejs-api", "nodejs-sequelize-api"],
+  "author": "Gülali Çelik",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/gulalicelik/nodejs-express-sequelize-mysql-api-boilerplate/issues"