Démarrage rapide

Ce guide vous permettra de lancer DBKeep rapidement sur votre machine locale.

Prérequis

Avant de commencer, assurez-vous d'avoir installé :

Node.js v20 ou supérieur
pnpm v9 ou supérieur
PostgreSQL v14 ou supérieur

Installation

1. Cloner le dépôt

git clone https://github.com/steeven-th/dbkeep.git
cd dbkeep

2. Installer les dépendances

pnpm install

3. Configurer l'environnement

Copiez le fichier d'exemple et modifiez-le selon vos besoins :

cp .env.example .env

Éditez le fichier .env :

# Base de données PostgreSQL
DATABASE_URL=postgresql://user:password@localhost:5432/dbkeep

# Authentification
BETTER_AUTH_SECRET=votre-cle-secrete-min-32-caracteres
BETTER_AUTH_URL=http://localhost:3000

# Mode (optionnel)
NUXT_PUBLIC_GUEST_MODE=false
NUXT_PUBLIC_ENABLE_REGISTER=true

4. Créer la base de données

# Créer la base de données PostgreSQL
createdb dbkeep

# Synchroniser le schéma
pnpm db:push

5. Lancer le serveur

pnpm dev

L'application est disponible sur http://localhost:3000.

Mode invité (utilisation personnelle)

Pour utiliser DBKeep sans gestion de comptes :

NUXT_PUBLIC_GUEST_MODE=true

Dans ce mode, tous les projets sont accessibles sans connexion.

Commandes utiles

Commande	Description
`pnpm dev`	Serveur de développement
`pnpm build`	Build de production
`pnpm db:push`	Synchroniser le schéma BDD
`pnpm db:studio`	Interface Drizzle Studio
`pnpm lint`	Linter le code
`pnpm test`	Lancer les tests

Prochaines étapes

Configuration avancée - Variables d'environnement détaillées
Déploiement Docker - Déployer avec Docker
Créer votre premier projet - Guide d'utilisation