Arquivo de configuração

Descrição

O arquivo m3Cms.config.js é um arquivo de configuração utilizado para configurar a integração entre o frontend e um CMS (Sistema de Gerenciamento de Conteúdo) interno chamado m3cms. Este arquivo deve ser criado na raiz do seu projeto para garantir o funcionamento adequado da biblioteca m3cms. A configuração permite que você especifique vários parâmetros necessários para identificar o ambiente e obter dados da API do CMS.

Abaixo está a documentação detalhada do arquivo de configuração:

Configuração

1. Crie o arquivo m3Cms.config.{js|ts|cjs|mjs} na raiz do seu projeto.
2. Configure os parâmetros necessários com base na configuração do seu CMS.
3. A biblioteca m3cms utilizará essa configuração para obter o conteúdo da API do CMS especificada.

URL base da API

A baseUrl deve apontar para o backend do CMS e não para a interface frontend ou de administração. Isso garante que a biblioteca m3cms se comunique diretamente com a API do CMS para obter os dados.

Certifique-se de substituir os valores de exemplo pelos valores reais correspondentes à configuração do seu CMS.

API

{
  projectName: string,
  workspaceName: string,
  baseUrl: string, 
  locale?: 'pt-BR' | 'en-US' | 'es-ES',
}
  

Parâmetros

Nome	Descrição	Tipo	Exemplos	Valor Padrão
locale	O idioma a ser utilizado para obter o conteúdo do CMS.	Locale (opcional)	'en-US', 'pt-BR', 'es-ES'	'pt-BR'
projectName	O nome do projeto dentro do CMS.	string	'MinhaLoja', 'SiteCorporativo'	-
projectId	Id do projeto dentro do CMS.	string (opcional)	'clid6mk3x0004j7y5l3rzex44',	-
workspaceName	O nome do espaço de trabalho dentro do projeto.	string	'master', 'development', 'staging'	-
baseUrl	A URL base da API do CMS.	string	'http://cms-backend.exemplo.com/api/v1'	-

Exemplos:

Javascript (ESM)

./m3Cms.config.js

/**
 * @type {import('@m3cms/api').M3CmsConfig}
 * */
const config = {
  projectName: 'MinhaLoja',
  workspaceName: 'dev',
  baseUrl: 'http://cms-backend.exemplo.com/api/v1'
};

export default config;

Javascript (CommonJS)

./m3Cms.config.cjs

/**
 * @type {import('@m3cms/api').M3CmsConfig}
 * */
const config = {
  projectName: 'MinhaLoja',
  workspaceName: 'master',
  baseUrl: 'http://cms-backend.exemplo.com/api/v1'
  locale: 'en-US'
};

module.exports = config;

Typescript

./m3Cms.config.ts

import type { M3CmsConfig } from '@m3cms/api';

const config: M3CmsConfig = {
  projectName: 'MinhaLoja',
  workspaceName: 'FulanoDev',
  baseUrl: 'https://cms-backend.exemplo.com/api/v1'
  locale: 'pt-BR'
};

export default config;

Assegure-se de importar ou utilizar adequadamente este arquivo em seu código frontend para possibilitar a integração perfeita com a biblioteca m3cms e o CMS interno.