Catalogue du Centre National de Documentation FFCAM

Ce dépôt contient le code source de l'application web de consultation et de recherche du catalogue du Centre National de Documentation de la Fédération Française des Clubs Alpins et de Montagne (FFCAM).
L'application est développée en utilisant Next.js et le backend est alimenté par Supabase.
Visiter l'application »

Soumettre un bug · Demander une fonctionnalité · Contribuer

Fonctionnalités

• Recherche dans le catalogue du Centre National de Documentation de la FFCAM parmi plus de 15 000 ouvrages
  • livres
  • cartes
  • films
  • magazines
• Consultation des résultats de recherche
• Affichage des détails d'un document spécifique
• Interface utilisateur intuitive et conviviale

Prérequis

Avant de pouvoir exécuter l'application localement, assurez-vous d'avoir installé les éléments suivants :

• Node.js (version 18 ou supérieure)
• NPM (ou Yarn) pour gérer les dépendances

Installation

1. Clonez ce dépôt sur votre machine locale :

git clone [email protected]:FFCAM/centre-documentaire.git

2. Accédez au répertoire du projet :

cd centre-documentaire

3. Installez les dépendances nécessaires :

npm install

Configuration

Avant de pouvoir exécuter l'application, vous devez configurer les informations d'authentification de votre instance Supabase. Suivez les étapes ci-dessous :

1. Créez un fichier .env.local à la racine du projet.

2. Ajoutez les variables d'environnement suivantes dans le fichier .env.local :

NEXT_PUBLIC_SUPABASE_URL=<URL_SUPABASE>
NEXT_PUBLIC_SUPABASE_ANON_KEY=<CLE_API_SUPABASE>

Remplacez <URL_SUPABASE> par l'URL de votre instance Supabase et <CLE_API_SUPABASE> par votre clé d'API Supabase.

Exécution

Une fois les dépendances installées et la configuration effectuée, vous pouvez exécuter l'application en utilisant la commande suivante :

npm run dev

Cela démarrera l'application en mode développement. Ouvrez votre navigateur et accédez à http://localhost:3000 pour voir l'application en action.

Contribution

Nous sommes ravis de recevoir des contributions pour améliorer cette application. Si vous souhaitez contribuer, veuillez suivre ces étapes :

1. Fork ce dépôt.
2. Créez une branche pour vos modifications :

git checkout -b feature/nouvelle-fonctionnalite

3. Effectuez les modifications nécessaires et committez-les :

git commit -m "Ajouter une nouvelle fonctionnalité"

4. Poussez les modifications vers votre dépôt forké :

git push origin feature/nouvelle-fonctionnalite

5. Ouvrez une pull request sur ce dépôt d'origine et décrivez vos modifications.

Déploiement

Cette application est déployée sur Vercel.
Un push sur la branche main déploie le code automatiquement sur https://centre-documentaire.vercel.app/.

Licence

Ce projet est sous licence MIT.