@gabrielkim13-nestjs/auth-activedirectory v0.0.3
NestJS Authentication Module
NestJS authentication module, using Active Directory services.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- NodeJS
- Yarn
- Visual Studio Code
- Make sure to install the recommended extensions when prompted.
Installing
To install all dependencies, run:
yarn
Configuration
Add the config.json
files (possibly copying and renaming the config.json.template
files).
Running the tests
Unit tests
Unit tests should test each component in isolation. To execute all tests, run:
yarn test
Each component layer is expected to be tested following the criteria below:
- Controllers are expected to call the correct Service for a given route path;
- Services are responsible for application logic and rely upon the funcitonality of Providers;
- Providers are expected to perform a very specific functionality, unrelated to the application business logic.
- Usually, Providers are an adapter layer between a NPM module and the interface required by the application.
It is also good practice to include unit tests for components such as Guards, Pipes, Interceptors and Exception Filters - which are patterns proposed by NestJS. For more information on what these components' reponsabilities are, please refer to NestJS's documentation.
E2E tests
E2E or End-to-end tests verify the overall health of the API, ensuring that each component and its interactions with the other components and system infrastructure are working as expected. To execute all e2e tests, run:
yarn test:e2e
Deployment
This section is under construction...
To build the application from scratch, run:
yarn clean && yarn build
And then execute the application in production mode with:
yarn start:prod
Built With
- NestJS - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
Contributing
This project uses EditorConfig, ESLint and Prettier for editor configuration, static code analysis and code-style guide, respectively.
Please make sure to use VSCode and install the recommended extensions to properly adhere to this project's contributing guidelines.
Versioning
This section is under construction...
Authors
- Gabriel Kim - Developer / Maintainer - Gabriel.Kim@tecban.com.br
Managers
- Arlei Oliveira - SSEC team manager - Arlei.Oliveira@tecban.com.br
- Maurício Tucci - Executive SSEC / SLATM manager - Mauricio.Tucci@tecban.com.br