@samet-digital/be-api-common v2.0.3

Back-End: Api Common

npm i @samet-digital/be-api-common

Requisite

Go to Back End Group and read items below;

• Installing git
• Setting up SSH keys for secure connection
• Setting up samet-digital project folder
• Installing NPM & Node

Clone Project

# Go to back-end projects folder
cd samet-digital/back-end

# [Case Linux & Mac] ==> Now, you should be at /Users/< user >/projects/samet-digital/back-end/
pwd

# Case [Windows] ==> Now, you should be at C:\Projects\samet-digital\back-end\
@echo %cd%

# Work on development branch at initial
git clone git@gitlab.com:samet-digital/back-end/api-common.git -b development

Publish Project

# collects all dependencies
npm i
# if you face any conflict between different versioned dependencies, please add --force flag
npm i --force

# builds project dist (typescript to javascript)
npm run build

# publishes component on http://npmjs.com/
npm run publish:public

Other Npm Commands

# clears "dist" folder*
npm run clear

# clears "dist" and "node_modules" folder*
npm run clear:nm

# executes static code analysis
npm run lint

# copies src/assets to dist/assets
npm run assets

# runs test cases
npm run test

# runs test cases with watch option
npm run test:watch

# runs test cases with coverage, and export coverage report
npm run test:coverage

# finds outdated/legacy packages
npm outdated

Standards

• Language: TS
• Eslint: Yes
• Inspections: Yes IntelliJ Code Inspections
• DDD - Domain Driven: Yes
• EDD - Exception Driven: Yes
• TDD - Test Driven: Yes
• LDD - Log Driven: Yes

Author

• Date 2025-04-27
• Name Mustafa Yelmer