adegbengaagoro

Module Creation Guide

This guide walks you through creating a new domain module in the TN Naija Membership Portal API. Every module follows the Module Facade Pattern - a single index.ts file exposes a static system class as the module's public API, while all internals (actions, models, controllers, routes) remain private.

Most modules are HTTP-facing and expose route properties. Service modules (like notifications) can skip Controllers/Routes and expose only callable methods through the facade.

Use the existing members module as a living reference throughout this guide.

---

adegbengaagoro

Card Effect System Documentation

1. Introduction

This document describes the architecture and workflow of the card effect system within the Yu-Gi-Oh! Web Duel Interface. The system is responsible for handling the activation, chaining, and resolution of card effects according to Yu-Gi-Oh! rules. It integrates declarative effect definitions (partially implemented via YAML/JSON) with the core game engine logic.

The system aims to manage:

• Activation: Determining when and if a card effect can be activated.
• Chaining: Building a sequence of effects when multiple effects are activated in response to each other.
• Resolution: Executing the effects in the correct (Last-In, First-Out) order.

adegbengaagoro

System Prompt: Architectural Principles to Code By

Use rg tool to search for files efficiently

Core Principles

1. Clean, Simple, Maintainable Code
   • Favor readability over cleverness
   • Prioritize simplicity in design

• Write code that future developers can easily understand

adegbengaagoro

Secure Design Principles

Defense in Depth

Also known as layered defense, defense in depth is a security principle where single points of complete compromise are eliminated or mitigated by the incorporation of a series or multiple layers of security safeguards and risk-mitigation countermeasures.

Have diverse defensive strategies, so that if one layer of defense turns out to be inadequate, another layer of defense will hopefully prevent a full breach.

Fail Safe

A security principle that aims to maintain confidentiality, integrity and availability by defaulting to a secure state, rapidly recovering software resiliency upon design or implementation failure. In the context of software security, fail secure is commonly used interchangeably with fail safe, which comes from physical security terminology.

adegbengaagoro

class Recipe {  
  int mango;  
  int milk;  
  int sugar;  
  
  Recipe(this.mango, this.milk, this.sugar);   
  
  int makeMangoShake() {  
    return mango+milk+sugar;  
  }  

adegbengaagoro

Important SonarLint Rules for JavaScript Development in Crenet

This rules should be enabled in your VSCode Settings (JSON view). Just replace the object you find in your settings with the object below

"sonarlint.rules": {
	
		"Web:BoldAndItalicTagsCheck": {
			"level": "off"
		},

adegbengaagoro

Framework Coverage

General Concepts

• Endpoint URL Definition
• Postman API Documentation
• Issue tracking via Github Issues
• Git Methodologies
  • Frequent small commits
  • Push task to branch whether complete or incomplete at end of day
• Single issue per Gitflow feature branch

adegbengaagoro

Service Class Structure

The idea is to have a set of consistent methods that are exposed from the service, the service is a class with static methods.

Generic Methods

getXById
getXByIdentifier
getXBySlug
getX

adegbengaagoro

import BaseSeeder from '@ioc:Adonis/Lucid/Seeder'
import Database from '@ioc:Adonis/Lucid/Database'
import SettingsCity from 'App/Models/SettingsCity'

export default class SettingsCitiesSeeder extends BaseSeeder {
  public async run() {
    const citiesData = [
      {
        city_label: 'Agege LGA',
        state_id: 25,

adegbengaagoro

Route.get('posts', async ({ request, view }) => {
  const posts = [
    {
      title: 'Adonis 101',
    },
  ]

  switch (request.accepts(['html', 'json'])) {
    case 'html':
      return view.render('posts/index', { posts })