Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mightyhorst/example-nestjs
Example Js
https://github.com/mightyhorst/example-nestjs
Last synced: about 2 months ago
JSON representation
Example Js
- Host: GitHub
- URL: https://github.com/mightyhorst/example-nestjs
- Owner: mightyhorst
- Created: 2019-09-20T01:04:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T06:20:46.000Z (about 2 years ago)
- Last Synced: 2024-04-13T11:54:43.902Z (9 months ago)
- Language: TypeScript
- Size: 1.13 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Quick Start Installation
```bash
nvm use 9 #node 9 or above
yarn run install:cli
yarn install
```
## Running the app
```bash
# development
yarn run start
# watch mode
yarn run start:dev
# production mode
yarn run start:prod
```
## Test
```bash
# unit tests
yarn run test
# e2e tests
yarn run test:e2e
# test coverage
yarn run test:cov
```
## Contact
- Author - Nick Mitchell [email protected]
## API
The main swagger docs can be found by `yarn run start:dev`
then navigating to [http://localhost:3000/docs](http://localhost:3000/docs)
## Development
#### Elastic Search queries
See the [wiki](https://itdwiki.det.nsw.edu.au/display/UD/Elasticsearch+APIs+for+frontend)
### Versioning
The version structure of this application aligns roughly to the JIRA board, that is:
- The **MAJOR** version aligns to the JIRA Release eg. v1 for MVP
- The **MINOR** version aligns to the sprint number which is currently sprint 4 eg. v1.4
- The **PATCH** version aligns to the CI build system build number which is generated for each deployment.