setup dynamic module with all needs

[SoufianeBenbah]

Create referral module with ESLint and Prettier configurations

ClickUp Task

#TASK_ID

💬 Description

This PR creates a dynamic NestJS module for referral code generation, addressing the need for unique referral codes based on a project key. This feature is essential for enabling distinct code generation across multiple projects, while also ensuring compliance with banned word restrictions.

🚨 Changelog

• .eslintrc.js: Added ESLint configuration using Avicenne's ESLint settings.
• .gitignore: Created a gitignore file to exclude compiled output and node_modules.
• .husky/pre-commit: Implemented pre-commit hooks to enforce linting and testing before committing.
• .husky/pre-push: Set up pre-push hook to ensure builds succeed before pushing to remote.
• .prettierrc: Integrated Prettier configuration based on Avicenne's Prettier settings.
• README.md: Updated the readme to provide documentation about the new referral module's features.
• nest-cli.json: Configured the Nest CLI for improved project setup.

🔬 Test Zone

• 🎨 Design check - Element Design reference - (Pixel perfect, Dimensions, Colors, Typography, Images, Responsiveness)

• Manual test for the referral code generation process.
• Review the setup and functionality of ESLint and Prettier configurations.
• Confirm pre-commit and pre-push hooks function as intended.
• Test various scenarios for encoding and validating referral codes, ensuring banned words are respected.

📝 Additional Notes

• This module depends on the Avicenne ESLint and Prettier configurations.
• Future tests and assertions regarding the referral code business logic will be required to ensure comprehensive unit test coverage.
• Ensure compatibility with existing projects that might utilize the referral module functionality.

[farischt]

Has to be tested on an external project

[farischt]

module.exports = {
  extends: ["@avicenne-studio"],
};

[farischt]

Not needed to start a server for this

[farischt]

IMO we should do the following things:

• A simple node npm package in plain typescript that handles the code generation
• Optionnaly create a nest js module that uses that library to generate codes

@wepee @au2001 any thoughts on that

[au2001]

IMO we should do the following things:

• A simple node npm package in plain typescript that handles the code generation
• Optionnaly create a nest js module that uses that library to generate codes

Totally agree yes