https://github.com/byndyusoft/nest-template

Base template for NestJS applications
https://github.com/byndyusoft/nest-template

nestjs template

Last synced: 11 days ago
JSON representation

Base template for NestJS applications

• Host: GitHub
• URL: https://github.com/byndyusoft/nest-template
• Owner: Byndyusoft
• License: apache-2.0
• Created: 2021-08-10T07:46:52.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T05:50:20.000Z (2 months ago)
• Last Synced: 2024-10-30T08:39:29.516Z (2 months ago)
• Topics: nestjs, template
• Language: TypeScript
• Homepage: https://github.com/Byndyusoft/nest-template/wiki
• Size: 9.44 MB
• Stars: 11
• Watchers: 11
• Forks: 2
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ᐸRepository nameᐳ

[![test](https://github.com/Byndyusoft/nest-template/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/Byndyusoft/nest-template/actions/workflows/test.yaml)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

ᐸRepository descriptionᐳ

## Monorepo

Monorepo structure is described in root [package.json](./package.json) and contains the following packages:

- [app](./packages/app) - executable service

- [client](./packages/client) - service client

- [dtos](./packages/dtos) - common dtos between service and its client

- [dtosTesting](./packages/dtosTesting) - dtos factories for unit tests

- [entities](./packages/dtosTesting) - entities

- [migrator](./packages/migrator) - service migrator

## Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

- [Git](https://git-scm.com)

- [Node.js](https://nodejs.org) (version 16 LTS or higher)

- [Yarn](https://yarnpkg.com) package manager

## Code conventions

Some code conventions are enforced automatically by ESLint + Prettier + markdownlint + husky + lint-staged stack.

## Service development lifecycle

- Implement business logic

- Add or adapt unit-tests (prefer before and simultaneously with coding)

- Add or change the documentation as needed

- Open pull request in the correct branch. Target the project's `master` branch

## Running locally

Service can be run locally using the following command:

```bash

yarn install

yarn run build

yarn run start

```

## Maintainers

- [@Byndyusoft/owners](https://github.com/orgs/Byndyusoft/teams/owners) <>

- [@Byndyusoft/team](https://github.com/orgs/Byndyusoft/teams/team)

- [@KillWolfVlad](https://github.com/KillWolfVlad)

## License

This repository is released under version 2.0 of the

[Apache License](https://www.apache.org/licenses/LICENSE-2.0).