NestJS Sandbox
Lab-project for NestJS API-Application that can be used as a template for new, independent projects.
Overview
The NestJS Sandbox API-App is a playground application designed to test technology related to APIs and TypeScript. While it does not provide a fully working application, it serves as a work-in-progress approach and can be a source of inspiration or a starting point for building your next app. The repository is marked as a template to serve as a starting point for new projects. The application follows a branching strategy using git-flow, with the main development branch named "develop" and finished features living in the "main" branch. The application also integrates commitizen for commits and release automation using release please. It also has continuous integration pipelines for the main and development branches.
Features
- Commitizen friendly
- CodeFactor for code quality analysis
- codecov for coverage scanning
- FOSSA for license scanning
- StatusCode for API documentation generation
- Smells for code smell detection
- Lines of Code for tracking code metrics
- Maintainability Rating for assessing code maintainability
- Technical Debt for tracking and managing technical debt
- Vulnerabilities for scanning and detecting vulnerabilities
- Bugs for tracking and managing bugs
- Security Rating for assessing code security
Summary
The NestJS Sandbox API-App is a WIP application that serves as a playground for testing APIs and TypeScript. It is not intended to be a fully working application, but rather a source of inspiration or a starting point for new projects. The application follows a branching strategy, integrates commitizen and release please for automated changelog and releases, and has continuous integration pipelines. Additionally, it can be transformed into a microservice application using the NestJS microservice module.