Skip to content

GoofyTeam/RandomGraill

Repository files navigation

RandomGraill

RandomGraill est une application qui vous permet de rechercher des restaurants autour d'une adresse ou de votre position actuelle, et de choisir de manière aléatoire où manger grâce à une roue interactive.

Fonctionnalités

  • Recherche par adresse : Entrez une adresse et obtenez une liste de restaurants situés à proximité.
  • Recherche par position actuelle : Utilisez la géolocalisation pour trouver les restaurants proches de vous.
  • Roue de décision : Créez une roue qui sélectionnera de manière aléatoire un restaurant parmi ceux proposés.

Installation

  1. Copier le fichier (front/)firebaseCredentials.example et renommez le (front/)firebaseCredentials.ts et ajoutez-y la configuration du projet Firebase. La configuration est sur discord.
//front/firebaseCredentials.example
export const firebaseConfig = {
apiKey
authDomain
projectId
storageBucket
messagingSenderId
appId
};

export const functionsURL = '';

export const DB_NAME = null;
  1. Installez les dépendances du projet
npm install
cd front && npm install
  1. Lancez le serveur de développement
  npm run dev
  1. Lancez le build du front
  npm run build
  1. Prévisualisez l'application
  npm run preview

Conventions

Commits

Nous utilisont commitlint, les messages de commit doivent donc suivre la convention suivante :

type(scope?): subject  #scope est facultatif; des scope simultanés sont possible (pour les delimiter : "/", "\" et ",")

La liste des types disponibles est :

  • build: Changements qui affectent le système de construction ou les dépendances externes (exemples de champs d'application : gulp, broccoli, npm)
  • ci: Changements dans nos fichiers de configuration et scripts CI (exemples : Travis, Circle, BrowserStack, SauceLabs)
  • docs: Changements dans la documentation uniquement
  • feat: Une nouvelle fonctionnalité
  • fix: Correction d'un bogue
  • perf: une modification du code qui améliore les performances
  • refactor: une modification du code qui ne corrige pas de bogue et n'ajoute pas de fonctionnalité
  • style: Changements qui n'affectent pas la signification du code (espaces blancs, formatage, points-virgules manquants, etc.)
  • test: Ajout de tests manquants ou correction de tests existants
  • wip: Du code en cours de développement
  • chore
  • revert

Déploiement

Le déploiement de l'application se fait automatiquement à chaque push sur la branche main via GitHub Actions. Les clés secrètes necessaires au déploiement sont :

  • FIREBASE_SERVICE_ACCOUNT_[FIREBASEPROJECTNAME] : La valeur de la clé de service Firebase (via Google Cloud Platform)

Changelogs

⚠️TITLE YYYY-MM-DD

This is a text.

.

About

Find where to eat easily

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors 6