Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hsstud 172 #73

Merged
merged 14 commits into from
Feb 23, 2023
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,10 @@ Added basic project st. with following features
- [Mongo Database connection](https://github.com/hypersign-protocol/studio-api/commit/357436181e4a525fe50b2c8cc4a50c016a437489)
- [environment var](https://github.com/hypersign-protocol/studio-api/commit/2d119e6898a772dcf6ff54e477eb5d354e9b4e18)


## Architecture

![img](https://camo.githubusercontent.com/c26967122228485ff75c80f03d4c9816759bc8fd0dd1a9477edb9a150f92479e/68747470733a2f2f6d656469612e646973636f72646170702e6e65742f6174746163686d656e74732f313032363338323037363937363537343532342f313034393932323436383531303434393636342f696d6167652e706e673f77696474683d31313535266865696768743d363631)


## Pre-requisites

Node version `v14.20.1`
Expand Down Expand Up @@ -82,12 +80,31 @@ $ yarn run start:prod
yarn test:newman
```

## create tag

- bump version and create tag

```bash
#command
yarn bumpVersion --ver ${flag/version-number}
#example
# yarn bumpVersion --ver patch // for bug fix
#yarn bumpVersion --ver minor // for minor changes
#yarn bumpVersion --ver major // for major changes
#yarn bumpVersion --ver 1.2.0 // for custom version
```

- push tag

```bash
yarn pushTag
```

## Docs

- http://localhost:3001/api
- http://localhost:3001/api-json


## Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
Expand All @@ -102,3 +119,6 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors

Nest is [MIT licensed](LICENSE).

```

```
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
"test:cov": "jest --coverage",
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
"test:e2e": "jest --config ./test/jest-e2e.json",
"bumpVersion": "npm version --tag-version-prefix ''",
"pushTag": "git push origin --tag"
"prepare": "husky install"
},
"dependencies": {
Expand Down