diff --git a/README.md b/README.md index d0e57eb..71c6aad 100644 --- a/README.md +++ b/README.md @@ -1 +1,6 @@ -Will be added ltr lol +How to get started with this project? +1) git clone or whatever you are comfortable with. +2) npm install in vscode termianl (assuming you have nodejs installed) + +Security in GIT repo. +i repeat DO NOT USE CREDS IN CODE! Please use .env files (https://www.npmjs.com/package/dotenv) diff --git a/package-lock.json b/package-lock.json index 87a27d9..48a2d60 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,6 +9,7 @@ "version": "1.0.0", "license": "ISC", "dependencies": { + "dotenv": "^16.3.1", "express": "^4.18.2", "mysql2": "^3.6.5", "sequelize": "^6.35.2" @@ -179,6 +180,17 @@ "npm": "1.2.8000 || >= 1.4.16" } }, + "node_modules/dotenv": { + "version": "16.3.1", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.3.1.tgz", + "integrity": "sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/motdotla/dotenv?sponsor=1" + } + }, "node_modules/dottie": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/dottie/-/dottie-2.0.6.tgz", diff --git a/package.json b/package.json index 51d6fa3..1d6e814 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,7 @@ }, "homepage": "https://github.com/Newtbot/MP#readme", "dependencies": { + "dotenv": "^16.3.1", "express": "^4.18.2", "mysql2": "^3.6.5", "sequelize": "^6.35.2"