README.md

Chaat

Description concise du projet.

Table des Matières

• Installation
• Configuration
• Lancement du Projet
• Structure du Projet
• Contributions
• Licence

Installation

1. Cloner le dépôt :

   git clone https://github.com/votre-utilisateur/votre-projet.git

2. Installer les dépendances de la frontend :

   cd client
   npm install

3. Installer les dépendances de la backend :

   cd api
   npm install

Configuration

1. Configurer la backend :

   • Renommer le fichier .env.example en .env.
   • Modifier les variables d'environnement dans le fichier .env selon vos besoins.

2. Configurer la frontend :

   • Si nécessaire, ajustez les configurations de l'API dans le fichier de configuration (src/config.js ou similaire).

Lancement du Projet

1. Lancer la backend (dans le dossier backend) :

   nodemon index.js

2. Lancer la frontend (dans le dossier frontend) :

   npm start

Le projet sera accessible à l'adresse http://localhost:3000/ par défaut.

Structure du Projet

• /api: Contient le code source de la backend.
• /client: Contient le code source de la frontend.
• /docs: Documentation supplémentaire.

Contributions

Veuillez consulter le fichier CONTRIBUTING.md pour connaître les détails sur notre code de conduite et le processus de soumission des demandes de tirage.

Licence

No licence