Here you can create and store yml files for each github action.
Github action to run and show linter errors on each Pull request, by default it scans every pull request and push to main, develop or master branches.
Folder which stores github hooks, by default it contains pre-commit hook which prevents push without fixing linter errors.
Settings and extensions specific to this project, for Visual Studio Code. See the editors doc for more.
You found me! 😉
Documentation config and destination folder See VuePress doc for more
Where we keep all our source files.
Where we keep common typescript files, e.g. constants and DTOs.
Folder to store files which are connected only to database.
Folder to store application migrations which will be generated by typeorm.
Factories are used to create entities which will be used in seeds.
Folder to store application seeds, it adds necessary data for the development.
This folder contains all global decorators.
In this folder you can find app level filters.
You can store all guards here.
Internalization JSON files are storied here.
Where we are keep interceptors.
This folder contains typescript interfaces
These are utility functions you may want to share between many files in your application. They will always be pure and never have side effects, meaning if you provide a function the same arguments, it will always return the same result.
Shared module with global singleton services.
Where all our NestJS modules lives. See NestJS modules documentation for more.
The root application module.
We extend built in classes so you can use helper function anywhere.
const users: UserEntity = ...; const userDtos = users.toDtos();
We are using snake naming strategy for typeorm, so when you will generate migration it automatically will set snake_case column name from entity fields.
Folder where we keep all our e2e test files.
List a files which will be ignored during the docker build.
Environment variables which will load before app start and will be stored in
p, (*) is a env name (development, test, staging, production)
Eslint configuration file, See the eslint doc for more.
Docker compose configuration file, See the docker docs for more.
basic Dockerfile configuration to build the app, See the docker docs for more.
Typeorm configuration file which is used for migrations and seeds.