Merge pull request #209 from amosproj/203-create-documentation-in-the…

…-wiki-for-devs-on-how-to-use-the-firestore-db Firebase DB Documentation
amosproj · Jun 25, 2024 · 72a1d7b · 72a1d7b
2 parents be0940a + 579e88e
commit 72a1d7b
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 0 deletions.
diff --git a/Documentation/WikiPages/ExpoWiki.md → ...on/WikiPages/BuildnRunExpoApp/ExpoWiki.md b/Documentation/WikiPages/ExpoWiki.md → ...on/WikiPages/BuildnRunExpoApp/ExpoWiki.md
diff --git a/Documentation/WikiPages/ailixir_project.png → ...ages/BuildnRunExpoApp/ailixir_project.png b/Documentation/WikiPages/ailixir_project.png → ...ages/BuildnRunExpoApp/ailixir_project.png
diff --git a/Documentation/WikiPages/download_build.png → ...Pages/BuildnRunExpoApp/download_build.png b/Documentation/WikiPages/download_build.png → ...Pages/BuildnRunExpoApp/download_build.png
diff --git a/...on/WikiPages/expo_select_organisation.png → ...dnRunExpoApp/expo_select_organisation.png b/...on/WikiPages/expo_select_organisation.png → ...dnRunExpoApp/expo_select_organisation.png
diff --git a/...ion/WikiPages/using_development_build.png → ...ldnRunExpoApp/using_development_build.png b/...ion/WikiPages/using_development_build.png → ...ldnRunExpoApp/using_development_build.png
diff --git a/Documentation/WikiPages/Firestore DB/FirebaseDBWiki.md b/Documentation/WikiPages/Firestore DB/FirebaseDBWiki.md
@@ -0,0 +1,44 @@
+# Navigating the Firebase Database
+
+The Firebase Database is mainly used for the frontend app. It can be accessed via the web interface or api methods in react native.
+
+## Requirements
+- Access to the [firebase project](https://console.firebase.google.com/project/amos-agent-framework/overview) (can be granted by the software developers)
+- Firebase account (login with a google account is also possible)
+- For react native development: firebase configuration in `.env` file in the project root directory (containing api keys and similar, message a developer to get the contents)
+
+## Web Interface
+
+Open the [Amos Agent Framework Project](https://console.firebase.google.com/project/amos-agent-framework/overview) in your web browser. Probably the two main functionalities that are needed can be found under `Build/Authentication` and `Build/Firestore Database`
+
+### 1.)
+ ![Navigate to Build](web_build_tab.png) 
+### 2.)
+![Authentication and Firestore Tabs](web_authentication_store.png)
+
+### Authentication
+
+In this tab you can see and manage (if you have the rights) information concerning user accounts registered in the app. Different sign-in methods can be set up (e.g. google and email signin). This tab can also be used to add new users, reset passwords, see registered email-addresses which partain to account user UIDs, etc.
+
+![Authentication Window](web_authentication_window.png)
+
+### Firestore Database
+
+In the firestore database you can organise data into collections that contain documents. The entries in this database can be retrieved in react native to for example display a username or chat.
+
+At this moment, we have a `users` collection containing all the users.
+
+![Firestore users](web_firestore_users.png)
+
+Here you can also create a user for yourself for testing purposes. For reference, see the already existing users.
+
+Each user can possess a `chats` collection containing all the different conversations with the chatbots. Here you can create new chats or see existing ones.
+
+![Firestore user chats](web_firestore_chats.png)
+
+Right now, a chat contains a `conversation` array, `createdAt` timestamp, `model` string and a `title` string.
+
+
+## React Native API
+
+For usage of the stored data in react native, you can for example take a look at the `src/frontend/hooks/` directory where different hooks for retrieving chat data are already implemented.
diff --git a/Documentation/WikiPages/Firestore DB/web_authentication_store.png b/Documentation/WikiPages/Firestore DB/web_authentication_store.png
diff --git a/Documentation/WikiPages/Firestore DB/web_authentication_window.png b/Documentation/WikiPages/Firestore DB/web_authentication_window.png
diff --git a/Documentation/WikiPages/Firestore DB/web_build_tab.png b/Documentation/WikiPages/Firestore DB/web_build_tab.png
diff --git a/Documentation/WikiPages/Firestore DB/web_firestore_chats.png b/Documentation/WikiPages/Firestore DB/web_firestore_chats.png
diff --git a/Documentation/WikiPages/Firestore DB/web_firestore_users.png b/Documentation/WikiPages/Firestore DB/web_firestore_users.png