https://github.com/hypersign-protocol/entity-ssi-api-service
A SSI API service built on multi tenant architeacture
https://github.com/hypersign-protocol/entity-ssi-api-service
Last synced: 4 days ago
JSON representation
A SSI API service built on multi tenant architeacture
- Host: GitHub
- URL: https://github.com/hypersign-protocol/entity-ssi-api-service
- Owner: hypersign-protocol
- Created: 2023-01-15T07:43:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-06-02T06:53:40.000Z (6 days ago)
- Last Synced: 2026-06-02T08:25:58.294Z (6 days ago)
- Language: TypeScript
- Homepage: https://api.entity.hypersign.id/ssi
- Size: 2.48 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Concepts with code commits
Added basic project st. with following features
- [Basic project st.](https://github.com/hypersign-protocol/studio-api/commit/d80f266d6ed4a458c66257b60b1df2bd84d1622b)
- [Modules](https://github.com/hypersign-protocol/studio-api/commit/0c27814642feee7ff4a517fd4cce257273ce683d)
- [Services](https://github.com/hypersign-protocol/studio-api/commit/0c27814642feee7ff4a517fd4cce257273ce683d)
- [Controllers](https://github.com/hypersign-protocol/studio-api/commit/0c27814642feee7ff4a517fd4cce257273ce683d)
- [Middleware](https://github.com/hypersign-protocol/studio-api/commit/9a6b7b396685cf9d9b592cfacb8e852cf918082f)
- [Swagger Doc](https://github.com/hypersign-protocol/studio-api/commit/e0b23fba36076c97daeaed8e6fbce7d0cb1abf24)
- [Validation](https://github.com/hypersign-protocol/studio-api/commit/4e73e7cbcfe699111581d53ad4c5d9a2bbca8260)
- [Exceptions](https://github.com/hypersign-protocol/studio-api/commit/bd6959b50216cded979309f62a8936c111d3b947)
- [DTOs](https://github.com/hypersign-protocol/studio-api/commit/0c27814642feee7ff4a517fd4cce257273ce683d)
- [Mongo Database connection](https://github.com/hypersign-protocol/studio-api/commit/357436181e4a525fe50b2c8cc4a50c016a437489)
- [environment var](https://github.com/hypersign-protocol/studio-api/commit/2d119e6898a772dcf6ff54e477eb5d354e9b4e18)
## Architecture
## Pre-requisites
Node version `v16.14.0`
```bash
npm i -g @nestjs/cli
```
## Use full commands
```bash
## Generate a new module
nest g module
## Generate a controller
nest g controller
## Generate a service
nest g service
## Generate a middleware
nest g middleware
```
## Installation
```bash
$ yarn
```
## Building the app
```bash
yarn build
```
## Running the app
```bash
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prod
```
## Test
```bash
#Test using postman collection
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).
## Stay in touch
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](LICENSE).
```
```
sudo nginx -s stop && sudo nginx