@dracul/customize-backend

Dracul Customize Module

The Customizable Module allows you in a simple and easy way to personalize your page.

This module allows:

• Selection of the platform language
• Configuration of the platform colors
• Customization of the logo and title of the platform
• Permissions to carry out said operations

Installation

npm i @dracul/customize-backend

Usage example

Simply merge the Resolvers & Types .

import {types as customTypes,resolvers as customResolvers} from '@dracul/customize-backend'

You simply have to merge the ** Configurations and Permissions ** at the beginning of the project..

import {initCustomization, initPermissionsCustomization} from '@dracul/customize-backend'

All the rest of the functionality is done through the frontend.

Enviroment variables

In your environment variables file (Example: .env), you must indicate the maximum size of the logo image. If the environment variable is not indicated, the default value is 2MB.

# Max logo file size in bytes. Ex: 10000000 Bytes == 1 MegaByte
LOGO_MAX_SIZE = 20000000

Querys & Mutations GraphQl

Customization

Get the logo, colors and language.

customization: Customization

CustomizationCreate

Create customizable settings.

customizationCreate (input: CustomizationInput): Customization

CustomizationUpdate

Update customizable settings.

customizationUpdate(id: ID!, input: CustomizationInput): Customization

ColorsUpdate

Updates the selected color.

colorsUpdate(input: ColorInput): Colors

LogoUpdate

Update the selected logo

logoUpdate(input: LogoInput): Logo

LogoUpload

Upload the selected logo

logoUpload(file: Upload!): LogoFile!

LangUpdate

Update the selected language

langUpdate(input: LangInput): Lang

Types & Input GraphQl

Those fields that contain !, are required.

Type Customization

type Customization{
    colors: Colors!
    logo: Logo!
    language: String!
}

Type Colors

type Colors{
    primary: String!
    onPrimary: String!
    secondary: String!
    onSecondary: String!
}

Type Logo

type Logo{
    mode: String!
    title: String
    filename: String
    url: String
}

Type Lang

type Lang {
    language: String!
}

Input CustomizationInput

input CustomizationInput{
    primary: String!
    onPrimary: String!
    secondary: String!
    onSecondary: String!
    logo: String!
    language: String!
}

Input ColorInput

input ColorInput{
    primary: String!
    onPrimary: String!
    secondary: String!
    onSecondary: String!
}

Input LogoInput

input LogoInput{
    mode: String!
    title: String
}

Type LogoFile

type LogoFile {
    filename: String!
    mimetype: String!
    encoding: String!
    url: String!
}

input LangInput

input LangInput{
    language: String!
}

Recommendation

It is recommended to use Scaffold, where you already have all the modules implemented to be able to use it as a project base. https://github.com/draculjs/scaffold