zen/core

Files

T

hykocx b8a6b3e86c docs: update org name from hykocx to zen and expand DEV guide

- Replace `hykocx` with `zen`/`HYKO` in LICENSE copyright notices
- Update npm registry scope from `@hykocx` to `@zen` in INSTALL.md
- Update npm auth token config path to use `zen` org in DEV.md
- Add project structure overview to DEV.md
- Add contribution standards section referencing GUIDE.md and REDACTION.md
- Add semver versioning bump reference table to DEV.md

2026-04-12 15:13:11 -04:00

1.3 KiB

Raw Blame History

Installation

1. Configurer le registre npm

Créer un fichier .npmrc à la racine du projet avec le contenu suivant :

@zen:registry=https://git.hyko.cx/api/packages/zen/npm/

2. Installer le package

npm install @zen/core

3. Installer les styles

Ajouter la ligne suivante dans le fichier globals.css :

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

4. Ajouter ZenProvider au layout racine

Entourer l'application avec ZenProvider dans le layout racine pour activer les notifications toast globalement :

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

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

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

5. Configurer les variables d'environnement

Consulter le fichier .env.example pour les variables d'environnement à ajouter dans le fichier .env.

6. Initialiser la base de données

npx zen-db init

Configuration

Configuration rapide

On peut créer tous les fichiers requis avec une seule commande :

npx zen-setup init

1.3 KiB Raw Blame History