Quickstart

Notiq can be used as a standalone editor component in your React or Next.js projects.

Installation

Install the core package using your preferred package manager:

pnpm add @collabchron/notiq

Setup

Import Styles

Add the Notiq styles to your root layout (e.g., app/layout.tsx):

import "@collabchron/notiq/styles.css";

Basic Usage

Use the Editor component in your application:

"use client";

import { Editor } from "@collabchron/notiq";

export default function Page() {
  return (
    <Editor 
      isEditable={true}
      aiConfig={{
        apiEndpoint: "/api/ai",
      }}
      uploadConfig={{
        uploadHandler: async (file) => {
          // Your custom upload logic
          return { url: "https://your-storage.com/file.png" };
        }
      }}
    />
  );
}

Local Development

If you want to contribute to Notiq:

Clone the repository:

git clone https://github.com/chinonsochikelue/notiq.git

Install dependencies:
```
pnpm install
```
Set up Environment: Create a .env.local with your OPENAI_API_KEY.
Run Dev Server:
```
pnpm dev
```

Explore Features

Quickstart

Quickstart

Installation

Setup

Import Styles

Basic Usage

Local Development

On this page