♻️ Updatedd documentation

lonestone · May 21, 2024 · 447c802 · 447c802
1 parent 36a08d3
commit 447c802
Show file tree

Hide file tree

Showing 8 changed files with 8,624 additions and 8,575 deletions.
diff --git a/README.md b/README.md
@@ -20,8 +20,8 @@ You can find Graphhopper project here : https://github.com/lonestone/graphhopper
 
 Don't forget to use the correct environnement before pushing your apps in production :
 
-* Check `.env` files
-* "baseUrl" in `api/config.json`
+- Check `.env` files
+- "baseUrl" in `api/config.json`
 
 A new version is automatically deployed on Render when a commit is pushed on main branch.
 
@@ -38,6 +38,7 @@ git push origin vX.Y.Z
 # Y : add new feature(s)
 # Z : minor fix(s)
 ```
+
 ## Staging vs prod
 
 > Warning : staging is the new prod
@@ -48,9 +49,9 @@ For the application you **must** check what is the current env in `config.json`
 
 For now, please change the url according to the wanted env :
 
-* Prod => "baseUrl": "https://naonair-api-staging.onrender.com/"
-* Preprod => "baseUrl": "https://naonair-api-preprod.onrender.com"
-* local => "baseUrl": "http://localhost:3001/"
+- Prod => "baseUrl": "https://naonair-api-staging.onrender.com/"
+- Preprod => "baseUrl": "https://naonair-api-preprod.onrender.com"
+- local => "baseUrl": "http://localhost:3001/"
 
 ## Docker
 
@@ -101,10 +102,27 @@ $ cd api
 # copy example to right file (don't commit it!)
 $ cp .env.example .env
 
+# go in app folder
+$ cd ../app/
+
+# copy example to right file (don't commit it!)
+$ cp .env.example .env
 ```
 
 Then, fill right properties
 
+## Install projects
+
+When you run the app for the first time, you need to install the dependencies.
+
+### IOS
+
+```
+# Go to the ios folder and build pods
+$ cd app/ios
+$ pod install
+```
+
 ## Start projects
 
 ```
@@ -139,6 +157,8 @@ PASS_KEY : Token used to be connected on backoffice
 JWT_KEY : Key to jwt token generation (Keep it secret)
 ```
 
+Add the `firebase.json` file at the root of the `api` folder.
+
 ## DTOs
 
 DTOs, as (Data Transfer Object), are defined in /dtos. It permits typing between api and front app.

diff --git a/app/.env.example b/app/.env.example
@@ -0,0 +1 @@
+POLLEN_TOKEN=
diff --git a/app/ios/Podfile.lock b/app/ios/Podfile.lock
@@ -743,7 +743,7 @@ SPEC CHECKSUMS:
   React-Core: 8293312ad137ea82fd2c29deb163dbc24aa4e00e
   React-CoreModules: 32fab1d62416849a3b6dac6feff9d54e5ddc2d1e
   React-cxxreact: 55d0f7cb6b4cc09ba9190797f1da87182d1a2fb6
-  React-debug: eb609f1405bf93b9f2524ef829260269417b2401
+  React-debug: dff23c1284aaaf91d4c3dbcc85625e538313de3a
   React-jsc: 0db8e8cc2074d979c37ffa7b8d7c914833960497
   React-jsi: 58677ff4848ceb6aeb9118fe03448a843ea5e16a
   React-jsiexecutor: 2c15ba1bace70177492368d5180b564f165870fd
@@ -752,7 +752,7 @@ SPEC CHECKSUMS:
   react-native-geolocation-service: 608e1da71a1ac31b4de64d9ef2815f697978c55b
   react-native-keep-awake: ad1d67f617756b139536977a0bf06b27cec0714a
   react-native-safe-area-context: 9697629f7b2cda43cf52169bb7e0767d330648c2
-  React-NativeModulesApple: c7caaf47265536f0d6e8b0ac11fa9494cb7d96ec
+  React-NativeModulesApple: b91df0c7bfabcaa8ce9c3479a82339f6edf9865a
   React-perflogger: 6bd153e776e6beed54c56b0847e1220a3ff92ba5
   React-RCTActionSheet: c0b62af44e610e69d9a2049a682f5dba4e9dff17
   React-RCTAnimation: fe7005136b58f58871cab2f70732343b6e330d30
@@ -766,9 +766,9 @@ SPEC CHECKSUMS:
   React-RCTVibration: ea3a68a49873a54ced927c90923fc6932baf344a
   React-rncore: 9672a017af4a7da7495d911f0b690cbcae9dd18d
   React-runtimeexecutor: 369ae9bb3f83b65201c0c8f7d50b72280b5a1dbc
-  React-runtimescheduler: 42543ceae5a3a763eba9dcd3ed361228fbfdfeb8
-  React-utils: c5f5ee7bed653ea51350fd0adbbe9211582c2305
-  ReactCommon: e8a4beae77c7a1d94d4aa873ee684e373940fc13
+  React-runtimescheduler: cb631a26989e555ba072ddb13c2c2f710bd2e66a
+  React-utils: b5dd2d7a34798086d9a663f2d54f730e8d539d9b
+  ReactCommon: 314b2d072ab865d679ed2eb3b9d2baf1257b84ed
   RNCAsyncStorage: f47fe18526970a69c34b548883e1aeceb115e3e1
   RNCMaskedView: 0e1bc4bfa8365eba5fbbb71e07fbdc0555249489
   RNFBAnalytics: fdecb8b774abd12f9ed79675794159d1a0fadc6c
@@ -785,4 +785,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 72134df57a4ed073dd565ecc70748d17b39db3ff
 
-COCOAPODS: 1.14.2
+COCOAPODS: 1.14.3
diff --git a/app/ios/aireal.xcodeproj/project.pbxproj b/app/ios/aireal.xcodeproj/project.pbxproj
@@ -10,7 +10,7 @@
 		00E356F31AD99517003FC87E /* airealTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 00E356F21AD99517003FC87E /* airealTests.m */; };
 		067AF0A905654DEBB4105485 /* MaterialIcons.ttf in Resources */ = {isa = PBXBuildFile; fileRef = EDDE8C003A1D47398B8CF5B8 /* MaterialIcons.ttf */; };
 		0A06A2C4BB57472A87D11E19 /* FontAwesome5_Solid.ttf in Resources */ = {isa = PBXBuildFile; fileRef = B5B79DE438344B9CBB261F64 /* FontAwesome5_Solid.ttf */; };
-		13B07FBC1A68108700A75B9A /* BuildFile in Sources */ = {isa = PBXBuildFile; };
+		13B07FBC1A68108700A75B9A /* (null) in Sources */ = {isa = PBXBuildFile; };
 		13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 13B07FB51A68108700A75B9A /* Images.xcassets */; };
 		13B07FC11A68108700A75B9A /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 13B07FB71A68108700A75B9A /* main.m */; };
 		2CFB9B7886744963A7DC631C /* lato_thin.ttf in Resources */ = {isa = PBXBuildFile; fileRef = 443DAC5B59F74537BE54430C /* lato_thin.ttf */; };
@@ -612,7 +612,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				13B07FBC1A68108700A75B9A /* BuildFile in Sources */,
+				13B07FBC1A68108700A75B9A /* (null) in Sources */,
 				2EC90FDF2A6AA89200127C2C /* AppDelegate.mm in Sources */,
 				13B07FC11A68108700A75B9A /* main.m in Sources */,
 			);
@@ -688,11 +688,9 @@
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_ENTITLEMENTS = aireal/aireal.entitlements;
 				CODE_SIGN_IDENTITY = "Apple Development";
-				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Distribution";
-				CODE_SIGN_STYLE = Manual;
+				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = 42;
 				DEVELOPMENT_TEAM = YR674NJJDX;
-				"DEVELOPMENT_TEAM[sdk=iphoneos*]" = YR674NJJDX;
 				ENABLE_BITCODE = NO;
 				INFOPLIST_FILE = aireal/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (
@@ -708,7 +706,6 @@
 				PRODUCT_BUNDLE_IDENTIFIER = org.airpl.naonair;
 				PRODUCT_NAME = aireal;
 				PROVISIONING_PROFILE_SPECIFIER = "";
-				"PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]" = "Naonair AppStore Distribution";
 				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
 				SUPPORTS_MACCATALYST = NO;
 				SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;
@@ -727,11 +724,9 @@
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_ENTITLEMENTS = aireal/aireal.entitlements;
 				CODE_SIGN_IDENTITY = "Apple Development";
-				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Distribution";
-				CODE_SIGN_STYLE = Manual;
+				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = 42;
 				DEVELOPMENT_TEAM = YR674NJJDX;
-				"DEVELOPMENT_TEAM[sdk=iphoneos*]" = YR674NJJDX;
 				INFOPLIST_FILE = aireal/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
@@ -746,7 +741,6 @@
 				PRODUCT_BUNDLE_IDENTIFIER = org.airpl.naonair;
 				PRODUCT_NAME = aireal;
 				PROVISIONING_PROFILE_SPECIFIER = "";
-				"PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]" = "Naonair AppStore Distribution";
 				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
 				SUPPORTS_MACCATALYST = NO;
 				SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;

diff --git a/app/src/components/templates/ARNews.tsx b/app/src/components/templates/ARNews.tsx
@@ -1,4 +1,4 @@
-import { NewsDTO, NewsType } from '@aireal/dtos/dist';
+import { NewsDTO, NewsType } from '@aireal/dtos';
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
 import { StyleSheet, View } from 'react-native';
 import { Caption, Headline, Modal, Paragraph } from 'react-native-paper';

diff --git a/app/src/config.json b/app/src/config.json
@@ -33,7 +33,7 @@
     }
   },
   "API": {
-    "baseUrl": "https://naonair-api-staging.onrender.com/",
+    "baseUrl": "http://localhost:3001/",
     "pollenURL": "https://www.alertepollens.org/api/gardens/NA44/"
   }
 }