From f0c7de95dee65e2b1a4ad1d779f17479e1fcc344 Mon Sep 17 00:00:00 2001 From: Puechberty Arthur Date: Mon, 30 Mar 2026 23:19:47 +0200 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20des=20informations=20d'i?= =?UTF-8?q?dentification=20par=20d=C3=A9faut=20dans=20.env.example=20et=20?= =?UTF-8?q?am=C3=A9lioration=20de=20la=20documentation=20dans=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.example | 6 +-- .gitignore | 4 ++ README.md | 102 ++++++++++++++++++++++++--------------------------- 3 files changed, 54 insertions(+), 58 deletions(-) diff --git a/.env.example b/.env.example index 4e54088..3fef639 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,4 @@ -ADMIN_USERNAME=admin -ADMIN_PASSWORD=123456 -ADMIN_SESSION_SECRET=change-me-in-production +ADMIN_USERNAME=change-me +ADMIN_PASSWORD=change-me +ADMIN_SESSION_SECRET=replace-with-a-long-random-secret PORT=3000 diff --git a/.gitignore b/.gitignore index 9a5aced..738b9f5 100644 --- a/.gitignore +++ b/.gitignore @@ -76,6 +76,7 @@ web_modules/ # Next.js build output .next +.next_perm_backup_*/ out # Nuxt.js build / generate output @@ -125,6 +126,9 @@ dist # Stores VSCode versions used for testing VSCode extensions .vscode-test +# Local VS Code workspace settings and deployment helpers +.vscode/ + # yarn v3 .pnp.* .yarn/* diff --git a/README.md b/README.md index d4003ff..4ff4183 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,85 @@ -# Social Links (Next.js) +# Links - Personal Link Hub -Une page de liens personnelle moderne construite avec Next.js (App Router). +Page de liens personnelle construite avec Next.js (App Router), avec une interface publique et un espace admin pour gerer les liens et consulter les analytics. -## Fonctionnalités +Lien du projet en ligne: https://links.arthurp.fr -- 🎨 UI moderne et responsive -- 🔎 Recherche instantanée dans les liens -- 🏷️ Filtres par catégories -- 🌗 Mode clair/sombre (persisté en local) -- 🔐 Espace admin protégé (analytics privées) -- ➕ Ajout et suppression de liens depuis le menu admin +## Points cles -## Installation +- Interface publique rapide et responsive +- Recherche et filtrage par categorie +- Espace admin protege par session +- Suivi des clics par lien +- Gestion des liens depuis l'admin (ajout/suppression) + +## Stack + +- Next.js 16 +- React 19 +- Stockage JSON local (`data/links.json`, `data/analytics.json`) + +## Lancer en local ```bash npm install -``` - -## Démarrage - -```bash +cp .env.example .env npm run dev ``` -Puis ouvre http://localhost:3000 +Application: http://localhost:3000 +Admin: http://localhost:3000/admin -## Scripts +## Variables d'environnement -- `npm run dev` : développement -- `npm run build` : build de production -- `npm start` : démarrage en production - -## Variables critiques (.env) - -Copie `.env.example` vers `.env` et ajuste les valeurs : - -```bash -cp .env.example .env -``` - -Variables requises : +Variables requises dans `.env`: - `ADMIN_USERNAME` - `ADMIN_PASSWORD` - `ADMIN_SESSION_SECRET` - `PORT` -## Configuration des données +Bonnes pratiques: -Modifie le fichier `config.js` : +- Utiliser un mot de passe admin fort +- Generer un secret de session long et aleatoire +- Ne jamais versionner le fichier `.env` -- `profile` : nom, bio, avatar -- `socialLinks` : liste de liens affichés +## Configuration du contenu -Chaque lien peut contenir : +Le profil et les liens affiches sont definis dans `config.js`. + +Pour chaque lien, renseigner: - `name` - `url` -- `icon` (fichier dans `public/`) +- `icon` - `description` - `category` -## Admin +## Deployment -- URL admin : http://localhost:3000/admin -- Identifiant : admin -- Mot de passe : 123456 +### Build local de verification -Dans le menu admin, vous pouvez : +```bash +npm run build +npm start +``` -- consulter les analytics (clics par lien) -- ajouter un lien -- supprimer un lien - -## Docker Compose - -Le `docker-compose.yml` lance maintenant : - -1. `npm install` -2. `npm run build` -3. `npm start` - -Test prod Docker : +### Docker ```bash docker compose up --build -d docker compose ps ``` +## SEO / Backlink + +Le projet public est accessible ici: + +- https://links.arthurp.fr + +Tu peux reutiliser cette URL dans tes profils, portfolios et articles pour renforcer le maillage vers ton site principal. + ## Licence -MIT - Voir [LICENSE](LICENSE) \ No newline at end of file +MIT - voir [LICENSE](LICENSE) \ No newline at end of file