Totoro-organization

Documentation »

Report bug - Request feature - Site

Totoro

Totoro est un service de proximité proposant à ses utilisateurs des missions à réaliser avec des associations en échange de tokens échangeables directement dans notre boutique contre des bons de réductions chez des commerçants locaux.

Sommaire

• Installation
• 🛠 Choix techniques 🛠
• Retour de bugs ou d'erreurs
• Documentation
• Contribution
• Version
• Copyright et licence

1 - Installation

Options d'installation :

Les scripts shell se trouvent dans le dossier cmd.

• Cloner le repo: git clone https://github.com/totoro-organization/totoro.git
• Création d'un fichier .env voir le modèle .env.template.
• Mettre à jour le projet : sh cmd/update-project.sh ou .\cmd\update-project.sh
• Installation via script shell : sh cmd/build.sh ou .\cmd\build.sh
• Installation que de l'api pour travailler en local : sh cmd/build.sh --build-local ou .\cmd\build.sh --build-local
• Installation du service de votre choix : sh cmd/build.sh --projects="image1;image2;image3..." ou .\cmd\build.sh --projects="image1;image2;image3..."
• Mettre à jour la base de donnée si la structure de l'api à changé : sh cmd/maj-db.sh ou .\cmd\maj-db.sh
• Relancer les services Docker : sh cmd/restart.sh or .\cmd\restart.sh

Exemple pour relancer 2 services sh cmd/restart.sh api webapp ou .\cmd\restart.sh api webapp

• Télécharger la dernière version de l'APK mobile

Si vous désirez en savoir plus sur l'infrastructure du projet, elle est visible dans la partie Documentation.

### Infrastructure

• api : http://localhost:6868
• swagger : http://localhost:6868/docs
• backoffice : http://localhost:3002
• webapp : http://localhost:3000
• phpmyadmin: http://localhost:8888
• mobileapp : http://127.0.0.1:19002

La Landingpage se trouve sur ce repo : https://github.com/totoro-organization/landing-page

• landingpage : http://localhost:5555

2 - 🛠 Choix techniques 🛠

Cliquer sur un badge, vous enverra directement sur leur site.

CI/CD 📦

• Plateforme 🧱

  

Conteneur 🗃

• Outil 🛠

  

Mobile 📱

• Methodology 📌

  

• Langage 📖

  

• Framework ⚛

  

• Outil 🛠

  

App 💻

• Langage 📖

  

• Framework ⚛

  

API 🔣

• Langage 📖

  

TEST 🧪

• Test unitaire

  

• Test e2e

  

• Exemple :

  cd webapp && npm start && npm run cypress
  

Hébergement 🏠

• Hébergement

  

3 - Retour de bugs ou d'erreurs

Vous avez un bug ou une demande de fonctionnalité ne marche pas correctement ? Veuillez d’abord lire la liste des issues disponible sur les problèmes existants et fermés. Si votre problème n’est pas encore abordé, veuillez ouvrir un nouveau ticket/issue.

4 - Documentation

Blablabla Doc de la webapp / bo / mobileapp / guide pour l'user.

Pour l'API nous utilisons Swagger, la documentation est disponible via https://api-totoro.herokuapp.com/docs

Services

Application	URL
API	https://api-totoro.herokuapp.com/
API doc	https://api-totoro.herokuapp.com/docs
Landing	https://totoro-landing.netlify.app/
Dashboard client	TODO
BackOffice admin	https://totoro-backoffice.netlify.app/login
App mobile	TODO: expo link
Messaging-service	TODO

5 - Contribution

tlugat 💻🐛📆👀	MaeWolff 📱👀🎨📆🐛	j2frise 💻🐛🔣	ElyasC 💻🔣
maellemoisis 🎨🖋

6 - Version

Dernière version : Totoro v0.01 - Disponible ici »

• Dernière version APK : Totoro-v0.01.apk - Disponible ici »

8 - Copyright et licence

Code and documentation copyright 2022