Skip to content

Commit 66a99d8

Browse files
committed
Update package.json version to 1.0.4 and add instructions for database configuration in README.md
1 parent 41634cb commit 66a99d8

File tree

3 files changed

+32
-5
lines changed

3 files changed

+32
-5
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,37 @@ npx @gulali/nodejs-express-sequelize-mysql-api-boilerplate my-project-api
1111

1212
## Usage
1313

14+
### Database configuration
15+
16+
edit config/config.json file and change your database name, username and password
17+
18+
```bash
19+
{
20+
"development": {
21+
"username": "root",
22+
"password": "",
23+
"database": "api_db_development",
24+
"host": "127.0.0.1",
25+
"dialect": "mysql"
26+
},
27+
"test": {
28+
"username": "root",
29+
"password": "",
30+
"database": "api_db_test",
31+
"host": "127.0.0.1",
32+
"dialect": "mysql"
33+
},
34+
"production": {
35+
"username": "root",
36+
"password": "",
37+
"database": "api_db_production",
38+
"host": "127.0.0.1",
39+
"dialect": "mysql"
40+
}
41+
}
42+
43+
```
44+
1445
```bash
1546
npm run start:dev
1647
```

bin/cli.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ const runCommand = command => {
1414
const repoName = process.argv[2];
1515
const gitCheckoutCommand = `git clone --depth 1 https://github.com/gulalicelik/nodejs-express-sequelize-mysql-api-boilerplate.git ${repoName}`;
1616
const installDepsCommand = `cd ${repoName} && npm install`;
17-
const rmGitRepoCommand = `rm -rf .git`;
1817

1918
console.log(`Cloning the repository with name ${repoName}`);
2019
const checkedOut = runCommand(gitCheckoutCommand);
@@ -24,9 +23,6 @@ console.log(`Installing dependencies for ${repoName}`);
2423
const installedDeps = runCommand(installDepsCommand);
2524
if (!installedDeps) process.exit(-1);
2625

27-
console.log(`Remove .git file ${repoName}`);
28-
const rmGitRepo = runCommand(rmGitRepoCommand);
29-
if (!rmGitRepo) process.exit(-1);
3026

3127
console.log(
3228
'Congratulations! You are ready. Follow the following commands to start'

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@gulali/nodejs-express-sequelize-mysql-api-boilerplate",
3-
"version": "1.0.3",
3+
"version": "1.0.4",
44
"description": "Nodejs Express Sequelize Mysql API Boilerplate with JWT, Swagger, Winston, PM2",
55
"main": "index.js",
66
"publishConfig": {

0 commit comments

Comments
 (0)