Streamlining Information: Adding FAQ Management with NestJS and Supabase

The vive-tu-mente-preview project, a platform dedicated to fostering mental well-being, recently received a crucial update: the integration of a comprehensive Frequently Asked Questions (FAQ) management system. This new feature allows administrators to easily add, update, and remove FAQs, providing users with quick access to common information without needing direct support.

The Need for FAQ Management

As applications grow, so does the volume of user inquiries. A dedicated FAQ section is an efficient way to offload common questions, improve user self-service, and reduce the burden on support teams. For vive-tu-mente-preview, implementing this system meant creating robust API endpoints and a reliable data storage solution.

Designing the FAQ API with NestJS

We leveraged NestJS to build a modular and scalable API for FAQ management. NestJS, with its strong architectural patterns like Dependency Injection and decorators, provides an excellent foundation for such features. The API defines standard RESTful endpoints for interacting with FAQ resources:

• GET /faqs: Retrieve all FAQs.
• GET /faqs/:id: Retrieve a specific FAQ by ID.
• POST /faqs: Create a new FAQ.
• PUT /faqs/:id: Update an existing FAQ.
• DELETE /faqs/:id: Remove an FAQ.

Swagger was integrated to automatically generate API documentation, making it easier for frontend developers to consume the new endpoints and for future maintenance.

Database Schema with Supabase

For data persistence, Supabase was chosen for its powerful PostgreSQL capabilities and ease of integration. A simple table was designed to store the FAQs, capturing the essential information:

CREATE TABLE faqs (
  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
  question TEXT NOT NULL,
  answer TEXT NOT NULL,
  created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
  updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
);

-- Add a trigger to update 'updated_at' on every row modification
CREATE OR REPLACE FUNCTION update_timestamp()
RETURNS TRIGGER AS $$
BEGIN
  NEW.updated_at = NOW();
  RETURN NEW;
END;
$$ language 'plpgsql';

CREATE TRIGGER update_faqs_updated_at
BEFORE UPDATE ON faqs
FOR EACH ROW
EXECUTE FUNCTION update_timestamp();

This schema ensures each FAQ has a unique identifier, a question, an answer, and automatically tracks creation and update times.

Implementing the FAQ Service in NestJS

Within NestJS, the FAQ logic is encapsulated in a dedicated service. This service interacts directly with the Supabase client (or a repository layer) to perform CRUD operations. Dependency Injection ensures that the database client is readily available where needed, promoting testability and maintainability.

Here's a simplified example of how a service method might look in TypeScript:

// src/faqs/faqs.service.ts
import { Injectable } from '@nestjs/common';
import { SupabaseClient } from '@supabase/supabase-js';

interface FaqItem {
  id: string;
  question: string;
  answer: string;
}

@Injectable()
export class FaqsService {
  constructor(private readonly supabase: SupabaseClient) {}

  async findAll(): Promise<FaqItem[]> {
    const { data, error } = await this.supabase
      .from('faqs')
      .select('*')
      .order('created_at', { ascending: true });

    if (error) {
      throw new Error(error.message);
    }
    return data as FaqItem[];
  }

  async create(question: string, answer: string): Promise<FaqItem> {
    const { data, error } = await this.supabase
      .from('faqs')
      .insert({ question, answer })
      .single();

    if (error) {
      throw new Error(error.message);
    }
    return data as FaqItem;
  }
}

This FaqsService handles the business logic, abstracting the database interactions from the controller. The controller then exposes these methods via HTTP routes.

Conclusion

The addition of FAQ management significantly enhances the vive-tu-mente-preview project's ability to serve its users effectively. By combining the structured development approach of NestJS, the robust database capabilities of Supabase, and clear API documentation with Swagger, we've delivered a feature that improves user experience and operational efficiency. This project demonstrates how modern web development stacks can be utilized to build powerful and maintainable backend systems.

Generated with Gitvlg.com