Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actuallyconnor/nest-js-starter
A Nest.js template project
https://github.com/actuallyconnor/nest-js-starter
Last synced: 28 days ago
JSON representation
A Nest.js template project
- Host: GitHub
- URL: https://github.com/actuallyconnor/nest-js-starter
- Owner: ActuallyConnor
- Created: 2022-03-12T15:37:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-03-12T16:01:34.000Z (over 2 years ago)
- Last Synced: 2024-06-09T19:25:03.868Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 238 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
An API for use by Example
## Description
An API for for use by [Example](https://www.example.com/)
## Documentation
### API Docs
[https://example.com/api-docs/index.html](https://example.com/api-docs/index.html)
### App Docs
[https://example.com/app-docs/index.htmlm](https://example.com/app-docs/index.html)
### SDK Code Docs
[https://example.com/sdk-docs/index.html](https://example.com/sdk-docs/index.html)
## Commands
### Installation
This project requires [Docker](https://docs.docker.com/get-docker/)
### Running the app
#### Development
```bash
# Install dependencies
$ npm install
# Build containers
$ make dev-build
$ make dev-up
```
_Note: this will run with `--watch` enabled, so it will automatically detect changes and auto-reload the environment_
#### Production
```bash
$ npm run start:prod
```
### Test
```bash
# integration tests
$ make dev-shell-node-worker
# Once inside the container
$ sh test.sh
```
### TypeORM
See [using the TypeORM CLI](https://github.com/typeorm/typeorm/blob/master/docs/using-cli.md)
```bash
# Create migration - name must be in PascalCase
npm run typeorm migration:create -- -n
# Run migrations
npm run typeorm migration:run
# Create - entity name must be in camelCase and you must suffix the name with ".entity"
npm run typeorm entity:create -- -n .entity
```
### Creating Nest files
```bash
# Create controller
nest g controller controllers/
# Create module
nest g module modules/
# Create service
nest g service services/
```
## SDK
[sdk-example](https://github.com/username/example/packages/1274697)
For any questions please reach out to [First Last](mailto:[email protected])
## Docker image
[example Docker image](https://github.com/username/example/pkgs/container/example)
First you need to log in into GitHub's Docker registry. This will require you to log in using a PAT (personal access
token) that has `read:packages` permissions.
```shell
# Docker login
docker login ghcr.io -u -p
```
Then you can pull the image
```shell
docker pull ghcr.io/username/example:latest
```