shell improve (#9)

* minor changes on npm script

* add DEVGUIDE

* changes on quick install

* docs improve

* shell improve

* add .gitkeep

Author: DevSazal

.npmignore

@@ -0,0 +1,6 @@
+**/node_modules
+**/.aws-sam
+**/.cache
+**/coverage
+package-lock.json
+.DS_Store

.prettierignore

@@ -1,4 +1,5 @@
 *.yaml
 *.yml
 *.json
-*.md
+*.md
+jest.config.ts

DEVGUIDE.md

@@ -5,9 +5,12 @@ install `awscliv2`, `aws-sam-cli`, `nodejs 18` (and `make` only for macOS and Li
 To build and deploy your application for the first time, run the following commands in your shell using `makefile` (only for macOS and Linux):
 
 ```bash
-make i
+make install
 make build
 make deploy
+
+# to delete the deployment
+make destroy
 ```
 
 The second command will build the source of your application. The 3rd command will package and deploy your application to AWS, with a series of prompts:

Makefile

@@ -1,21 +1,24 @@
 .PHONY: build build_cloudformation build_typescript clean clean_cache clean_dist clean_modules clean_tmp deploy deployci deploy_cloudformation destroy destroy_cloudformation lint lintfix
 
-#### input params
+#### input params for aws cloud
+#### Please change the value as required like region, stack & profile
+
 debug = debug
 maintenance = false
 region = eu-central-1
-stack = typescript-aws-lambda-serverless-restapi-kit # decide a stack-name for the app
+stack = typescript-lambda-backend-app   # decide a <stack-name> for the app
 stage = v1
-substage = sazal # x/developer-name
+substage = sazal   # add x/<DeveloperName>
 tests = unit
 ####
 
 #### cloud params
-profile = sazal-dev
+profile = sazal-dev    # add the name of aws cli configured profile
 stackname = ${stack}
 ####
 
 
+
 #### info
 help:
 	@echo ""
@@ -40,10 +43,12 @@ help:
 	@echo "- lint: lints service."
 	@echo "- lintfix: lint fix service."
 	@echo ""
+	@echo "- test: for testing all the features by jest."
+	@echo ""
 ####
 
 #### validate
-i:
+install:
 	@npm i
 
 #### validate
@@ -65,7 +70,7 @@ build_typescript:
 
 
 #### clean
-clean: clean_cache clean_dist clean_modules clean_tmp
+clean: clean_cache clean_dist clean_modules clean_coverage clean_tmp
 
 clean_cache:
 	@rm -rf .cache
@@ -76,6 +81,9 @@ clean_dist:
 clean_modules:
 	# @rm -rf node_modules
 
+clean_coverage:
+	@rm -rf coverage
+
 clean_tmp:
 	@rm -rf .tmp
 ####
@@ -122,3 +130,9 @@ lint:
 lintfix:
 	@npx --no-install prettier --write '{src,__tests__}/**/*.{js,ts}'
 ####
+
+#### Test
+test:
+	@npm run test
+
+####

README.md

@@ -51,10 +51,22 @@ install `awscliv2`, `aws-sam-cli`, `nodejs 18` (and `make` only for macOS and Li
 To build and deploy your application for the first time, run the following commands in your shell using `makefile` (only for macOS and Linux):
 
 ```bash
-make i
+make install
 make build
+```
+
+Before deployment, open the `Makefile` and add your AWS-configured profile name at the `profile` variable.
+
+Wait, you may try this command on your terminal to check what is the name of your aws-configured profile:
+
+```bash
+aws configure list-profiles
+```
+
+#### Let's make it live:
+
+```bash
 make deploy
-make destroy
 ```
 
 The 2nd command will build the source of your application. The 3rd command will package and deploy your application to AWS, with a series of prompts:

__tests__/unit/handlers/.gitkeep

@@ -53,11 +53,13 @@ async function main() {
 
         fs.unlinkSync(path.join(projectPath, 'bin', 'install.js'));
         fs.rmSync(path.join(projectPath, 'bin'), { recursive: true });
+        fs.unlinkSync(path.join(projectPath, 'events', 'sample-event.json'));
+        fs.unlinkSync(path.join(projectPath, '.npmignore'));
 
         // end notes
         console.log('\n');
         console.log('Installation is now complete!');
-        console.log('This is ready to use.');
+        console.log("You're ready to go...");
         console.log('\n');
         console.log('We suggest that you start by typing:');
         console.log(`    cd ${projectName}`);

__tests__/unit/handlers/test-handler.test.ts

@@ -1,6 +1,6 @@
 {
   "name": "ts-lambda-kit",
-  "version": "1.0.3-beta",
+  "version": "1.0.4-beta",
   "description": "aws lambda kit for making backend with NodeJS v18, TypeScript & SAM CLI",
   "keywords": [
     "ts-lambda-kit",