+ English | + 简体中文 | + Deutsch | + Français | + Español +
+ +## Nomenclature + +Here are some terms we will be using in this document: + +* ```Robot, bot``` - this is the Android software running on the phone on the [OpenBot](https://www.openbot.org/) +vehicle. +* ```Server``` - the web server, the server part of this project. +* ```Client, UI``` - this is the client part of this project. It runs in the browser. + +## Introduction + +This project operates remotely on a cloud server, functioning as a controller for +the [OpenBot](https://www.openbot.org/) vehicle. The software comprises two components: a server and a client. The +server is a cloud application deployed in a remote environment. The client component runs directly in the web browser. +Here is a screenshot of the browser: + ++ English | + 简体中文 | + Deutsch | + Français | + Español +
+ +- #### Usage + In our web application, we use Firebase for Google sign-in authentication to identify each unique client and prevent cross-connections between the robot app and the web server. If you clone this project and run on your device, you must set up your own Firebase project because the + firebase configuration is required for sign-in authentication. +- #### About Google Sign-In + Firebase Google Sign-In Authentication is a feature of the Firebase platform that allows users to sign in to mobile or + web apps using their Google credentials. This service provides a secure and convenient way for users to access apps + without having to remember and manage separate login credentials. Firebase manages the entire authentication process, + from verifying the user's identity with Google to providing a unique user ID that can be used to personalize the user' + s experience within the app. This feature also includes additional security measures, such as two-factor + authentication, to help protect user accounts from unauthorized access. + +**Note** - Please follow the OpenBot playground [documentation](../../../../open-code/src/services/README.md) to set up your Firebase project and enabling google authentication. No need to enable Google Drive API for now. + +### Setting up Environment Variables + +Using Environment Variables When using Firebase Authentication, you may need to store sensitive information such as API keys, database credentials, and other secrets. To do this securely, you can use environment variables to store this information outside your code. by doing following steps. + +1. Create a new file in web-server called .env. + +OpenBot
+Controller
+Your trial has just ended!
+To continue using OpenBot Controller, you will
+need to upgrade your plan.
+ +