@growrk/create-growrk-whitelabel

@growrk/create-growrk-whitelabel

Create a @growrk Whitelabel in seconds.

Getting Started

To get started quickly you can use the @growrk/create-growrk-whitelabel package

With yarn:

yarn create @growrk/growrk-whitelabel <project-name>

Or with npx (npx is shipped by default since npm 5.2.0)

npx @growrk/create-growrk-whitelabel <project-name>

Or starting with npm v6.1 you can do:

npm init @growrk/growrk-whitelabel <project-name>

It will ask you some questions (name, title, npmToken, etc.), when aswered the dependencies will be installed. The next step is to navigate to the project folder and launch it:

With yarn:

cd <project-name>
yarn dev

Or with npm:

cd <project-name>
npm run dev

nuxt.config.js

Import the core app function from @growrk/dashboard:

import growrkDashboard from "@growrk/dashboard";

export default growrkDashboard({
  // [additional nuxt configuration]
  growrkCoreOptions: {
    // [growrk core options]
  },
});

The app exports a function to setup the nuxt.config.js and allows you to add/override the default config.

Check out the documentacion of defu.arrayFn to see how the config is merged.

Example

import growrkDashboard from "@growrk/dashboard";

export default growrkDashboard({
  // [additional nuxt configuration]
  growrkCoreOptions: {
    colors: {
      primary: "#F3B72B",
      secondary: "#F38B2A",
      success: "#28a745",
      warning: "#F3B72B",
      danger: "#dc3545",
      info: "#007bff",
      light: "#f8f9fa",
      dark: "#343a40",
    },
    openGraph: {
      name: "GroWrk",
      title: "GroWrk Remote",
      description:
        "Smart home office and workspace management for remote teams.",
      url: "https://app.growrk.com",
      image: "https://app.growrk.com/cover.jpg",
      imageH: "1200",
      imageW: "630",
    },
  },
});