Skip to main content

Intro

Let's discover Quarkinos SDK in less than 10 minutes.

Getting Started​

Get started by creating a new application.

Or add our React and Next.js SDK to an existing application with @quarkino/services.

What you'll need​

  • Node.js version 18.0 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Generate a new application​

Generate a new Next.js project that's already integrated with the Quarkino's SDK using the @quarkino/create-quarkino-app CLI tool.

This command will generate a new project using a template that you chose and will add the necessary files for Quarkino's SDK to work correctly:

npx @quarkino/create-quarkino-app

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command can also installs all necessary dependencies you need to run Next.js and Quarkino's SDK.

Configure your .env file​

To correctly connect and use the Quarkino SDK you need to add an .env file to your project based on the data from panel an websites address:

BASE_URL="http://localhost:3000" # Should be changed to the deployment URL, If you use the generateMetadata Util this will be used there and can affect SEO
IMAGE_SOURCES="the-address-to-your-panel-without-the-http-part,by-using-a-comma-you-can-add-multiple-addresses"
NEXT_PUBLIC_API_ADDRESS="https://your-panel-address.com"

Start your app​

Run the development server:

cd name-you-chose
npm run dev

The cd command changes the directory you're working with. In order to work with your newly created Next.js application, you'll need to navigate the terminal there.

The npm run dev command will start the Next.js development server at http://localhost:3000/.