0.0.1 • Published 3 years ago
talent-acquisition-api v0.0.1
Talent API V1
Setup local development environment:
- GIT
- windows installer
- macOS "brew install git"
- linux
- VSCode Developer IDE
- MySQL workbench Current version v8.0.21
- NodeJS LTS Current version at v12.18.3
- Install the following npm global packages
$ npm i -g npm yarn webpack typescript ts-node tslint eslint nodemon
- NestJS Install the NestJS CLI
Setup VSCode workspace
- Clone this repository
- Open the workspace with VSCode
- Install the necessary npm packages required by the project
$ yarn install
Setup .env
Setup a '.env' in your workspace
NODE_ENV = 'development'
DB_HOST = '<MySQL HOST>'
DB_SCHEMA = 'talent_acquisition'
DB_USER = '<MySQL username>'
DB_PASSWORD = '<MySQL password>'
# PULSIFI CONFIGS
SEND_EMAIL = 'false' # 'true' or 'false'
PULSIFI_API_ALB = '<ALB url>'
DAXTRA_API_URL = 'https://cvxdemo.daxtra.com/cvx/rest/api/v1'
DAXTRA_ACCOUNT = 'API_TEST'
Running the app
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
Test
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
Swagger Docs
Sample API endpoints
0.0.1
3 years ago