Installation

1. Install the package

npm install @hykocx/zen

2. Install the styles

Add the following line to your globals.css file:

@import '@hykocx/zen/styles/zen.css';

3. Add ZenProvider to your root layout

Wrap your application with the ZenProvider in your root layout to enable toast notifications globally:

// app/layout.js
import './globals.css';
import { ZenProvider } from '@hykocx/zen/provider';

export const metadata = {
  title: 'My App',
};

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <ZenProvider>
          {children}
        </ZenProvider>
      </body>
    </html>
  );
}

4. Configure the environment variables

Check the .env.example file for the required environment variables to add to your .env file.

5. Initialize the database

npx zen-db init

Setup

Quick Setup

You can create all required files with a single command:

npx zen-setup init

1.0 KiB Raw Blame History