feat: Mise à jour du README et ajout d'un fichier .env.example pour la configuration

This commit is contained in:
Puechberty Arthur
2026-03-30 22:42:05 +02:00
parent c40fc78103
commit 53f07a1d85
4 changed files with 56 additions and 27 deletions
+9
View File
@@ -0,0 +1,9 @@
CLIENT_ID=VOTRE_BOT_CLIENT_ID
CLIENT_SECRET=VOTRE_BOT_CLIENT_SECRET
REDIRECT_URI=https://lazybot.arthurp.fr/auth/discord/callback
PORT=3000
BOT_TOKEN=VOTRE_BOT_TOKEN
SESSION_SECRET=UN_SECRET_LONG_ET_UNIQUE
DB_PATH=database.sqlite
OWNER=VOTRE_ID_UTILISATEUR
URL=https://lazybot.arthurp.fr
-3
View File
@@ -140,7 +140,4 @@ dist
# Vite logs files # Vite logs files
vite.config.js.timestamp-* vite.config.js.timestamp-*
<<<<<<< HEAD
vite.config.ts.timestamp-*
=======
vite.config.ts.timestamp-* vite.config.ts.timestamp-*
+41 -23
View File
@@ -1,49 +1,67 @@
# LazyBot - Discord Bot # LazyBot
Bot Discord configurable via un dashboard web pour gérer : LazyBot est un bot Discord multi-serveurs avec dashboard web pour configurer facilement votre serveur.
- Rôles automatiques (`autorole-newuser` et `autorole-vocal`)
- Messages de bienvenue et dau revoir
- Sélection de salons vocaux à exclure
- Multi-serveurs avec contrôle admin
--- Site officiel: https://lazybot.arthurp.fr
## Fonctionnalités
- Commandes générales, économie, niveaux, modération et administration
- Gestion d'autoroles (nouveaux membres et vocal)
- Messages de bienvenue et d'au revoir personnalisables
- Configuration anti-raid, logs, panels de roles, salons statistiques
- Dashboard web pour piloter les options serveur
## Stack
- Node.js
- Discord.js
- SQLite
- Docker et Docker Compose
## Installation ## Installation
1. Cloner le projet : 1. Cloner le projet
```bash ```bash
git clone https://github.com/arthur-pbty/LazyBot.git git clone https://github.com/arthur-pbty/LazyBot.git
cd mon-bot-discord cd lazybot
```` ```
3. Créer un fichier `.env` : 2. Creer votre fichier d'environnement
```bash
cp .env.example .env
```
3. Renseigner les variables dans `.env`
```env ```env
CLIENT_ID=VOTRE_BOT_CLIENT_ID CLIENT_ID=VOTRE_BOT_CLIENT_ID
CLIENT_SECRET=VOTRE_BOT_CLIENT_SECRET CLIENT_SECRET=VOTRE_BOT_CLIENT_SECRET
REDIRECT_URI=https://your_domaine.com/auth/discord/callback REDIRECT_URI=https://lazybot.arthurp.fr/auth/discord/callback
PORT=3000 PORT=3000
BOT_TOKEN=VOTRE_TOKEN_BOT BOT_TOKEN=VOTRE_TOKEN_BOT
SESSION_SECRET=un_secret_aleatoire_pour_les_sessions SESSION_SECRET=UN_SECRET_LONG_ET_UNIQUE
DB_PATH=database.sqlite DB_PATH=database.sqlite
OWNER=VOTRE_ID_UTILISATEUR OWNER=VOTRE_ID_UTILISATEUR
URL=https://ton-domaine.com URL=https://lazybot.arthurp.fr
``` ```
4. Lancer le serveur : 4. Lancer avec Docker
```bash ```bash
docker compose up -d --build docker compose up -d --build
``` ```
* Serveur web : `http://localhost:3000` Le dashboard est ensuite disponible sur `http://localhost:3000`.
* Le bot se connecte automatiquement aux serveurs où il est invité.
--- ## Securite avant publication
## Fonctionnalités clés - Ne jamais versionner `.env`
- Verifier que `.vscode/` reste ignore (ex: `sftp.json`)
- Eviter de publier des tokens, secrets ou cles privees
* Autoroles pour nouveaux membres et salons vocaux ## Licence
* Messages de bienvenue et dau revoir personnalisables
* Dashboard web pour configurer facilement chaque serveur Projet prive par defaut. Ajouter une licence explicite si publication open source.
* Pré-sélection automatique options anciennement remplit
+6 -1
View File
@@ -5,7 +5,12 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="LazyBot est un bot Discord puissant avec système de niveaux, économie, messages personnalisés et bien plus encore."> <meta name="description" content="LazyBot est un bot Discord puissant avec système de niveaux, économie, messages personnalisés et bien plus encore.">
<link rel="stylesheet" href="/index.css"> <!-- Preconnect CDN for avatars to reduce latency -->
<link rel="preconnect" href="https://cdn.discordapp.com" crossorigin>
<!-- Preload CSS and apply via onload to reduce render-blocking (noscript fallback) -->
<link rel="preload" href="/index.css" as="style" onload="this.rel='stylesheet'">
<noscript><link rel="stylesheet" href="/index.css"></noscript>
</head> </head>
<body> <body>
<!-- Navigation --> <!-- Navigation -->