zen/core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

docs: remove zen-setup CLI and simplify installation guide

Browse Source 
- Remove `zen-setup` binary from package.json and package-lock.json
- Replace manual setup steps with `npx @zen/start` CLI command
- Simplify INSTALL.md by reducing steps from 6 to 4
- Update DEV.md to reflect removal of zen-setup from CLI scripts
- Fix relative path to `.env.example` in documentation
This commit is contained in:
Hyko
2026-04-12 17:07:33 -04:00
parent 6e33726862
commit 2017f9791b
5 changed files with 11 additions and 310 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/DEV.md
+1 -1
View File
@@ -13,7 +13,7 @@ On suit ces deux guides :
```
src/
├── cli/ # Scripts CLI : zen-db, zen-setup
├── cli/ # Scripts CLI : zen-db
├── core/ # Briques techniques : database, api, email, storage, cron, pdf, toast, payments
├── features/ # Features utilisateur : auth, admin, provider
├── modules/ # Modules métier : posts, invoice, nuage…
docs/INSTALL.md
+8 -54
View File
@@ -1,69 +1,23 @@
# 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
## 1. Configurer le registre pour le scope `@zen` :
```bash
npm install @zen/core
npm config set @zen:registry https://git.hyko.cx/api/packages/zen/npm/
```
## 3. Installer les styles
## 2. Lancer le CLI :
Ajouter la ligne suivante dans le fichier `globals.css` :
```css
@import '@zen/core/styles/zen.css';
```bash
npx @zen/start
```
## 4. Ajouter ZenProvider au layout racine
## 3. Configurer les variables d'environnement
Entourer l'application avec `ZenProvider` dans le layout racine pour activer les notifications toast globalement :
Consulter le fichier [`.env.example`](../.env.example) pour les variables d'environnement à ajouter dans le fichier `.env`.
```javascript
// 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`](.env.example) pour les variables d'environnement à ajouter dans le fichier `.env`.
## 6. Initialiser la base de données
## 4. Initialiser la base de données
```bash
npx zen-db init
```
# Configuration
## Configuration rapide
On peut créer tous les fichiers requis avec une seule commande :
```bash
npx zen-setup init
```