feature(#144): Clean and update Brain, Android readmd

Android/README.md

@@ -1,47 +1,54 @@
-# RisingAndroid
+# 🌍 RisingBrain-Android:Your AI OS Companion 📱
 [![Android CI Develop](https://github.com/ttt246/RisingPhone/actions/workflows/android.yml/badge.svg?branch=develop)](https://github.com/ttt246/RisingPhone/actions/workflows/android.yml)
 [![Android CI](https://github.com/ttt246/RisingPhone/actions/workflows/android.yml/badge.svg?branch=main)](https://github.com/ttt246/RisingPhone/actions/workflows/android.yml)
 
-All complex software including operating systems will need to be rewritten from the ground up to take advantage of machine learning. In our OS, a AI will manage all apps via plugins, which can be prompted by the user. Our plugins can run as an openai plugin, or in our backend.
+Venture into the future of artificial intelligence with **RisingBrain Android**- an essential component of 🧠RisingBrain🧠 
 
-### RisingPhone
+We bring the revolutionary AI-powered OS right at your fingertips with our Android application.
+This Android counterpart ensures you get all the smart features of RisingBrain OS on your smartphone. 
 
-<p align='center'>
-  <img align='center' src='assets/img/desc.png' width='100%' />
-</p>
+Let's dive into the specifics!😆
 
-- 📱 Support for mobile devices to manage all apps via plugin as its launcher.
-- 🔗 Multiple API support (Web API for Free and Plus users, GPT-3.5, GPT-4, etc.).
-- 🔍 Integration to all mainstream search engines, and custom queries to support additional sites.
+## Getting Started 🏁
 
-### Features
+<p align='center'>
+  <img align='center' src='assets/img/desc.png' width='100%'>
+</p>
+<p align="center">
+    <img src="assets/img/architecture.png" width="92%">
+</p>
 
-| Title  | Description  |
-| ------------ | ------------ |
-| General Chat | Users can chat with AI plugins. |
-| Open Browser Automatically |  If a user is going to open browser, the app opens browser and search what a user wants automatically |
-| Image Search System  | A user can search image on Android local storage |
-| Send SMS | If a user says that send SMS, mobile open SMS editor and a user can send SMS using the editor. |
+This application has built with **MVVM architecture pattern**. (Using Android Architecture Components).
 
-### Run locally
-- Copy google-services.json into app folder of project
+Repository Pattern, to abstract the source of data in the application.
+Using of View Model, Live Data and data binding.
 
-### CI/CD
-- set google-services.json to github secrets
+***The Application utilizes such popular libraries as: [Room](https://developer.android.com/training/data-storage/room), [OkHttp](https://github.com/square/okhttp), [Retrofit](https://github.com/square/retrofit), [Glide](https://github.com/bumptech/glide), etc.
+Written in [Kotlin](https://kotlinlang.org/).***
 
+## Features 💫
 
-### Test
-- Unit Test
-- Instrumented Test
+|             Title              |                                                  Description                                                   |                             ScreenShot                             |
+|:------------------------------:|:--------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------:|
+| Around-the-Clock Conversations |                                        Enjoy casual chats with Rising AI, right from your Android device.                                         |  <img src="assets/img/general.png" width="270px" height="550px"/>  |
+|        Quick Web Tours         |      Experience swift and accurate browsing based on your interests or queries.      |  <img src="assets/img/browser.png" width="270px" height="550px"/>  |
+|        Picture Perfect         |                                Hunt for images using visual cues or descriptions with our smart image search.                                |   <img src="assets/img/image.png" width="270px" height="550px"/>   |
+|    Stay Connected, Swiftly     |         Find contacts and initiate calls or text messages without extra effort.         |  <img src="assets/img/contact.png" width="270px" height="550px"/>  |
+|      On-Time, Every Time       | Set timely reminders and never miss an important event with our alarm feature. |   <img src="assets/img/alarm.png" width="270px" height="550px"/>   |
+|         Swift Emailing         |                Send emails instantly, without having to switch between apps.                 |    <img src="assets/img/sms.png" width="270px" height="550px"/>    |
+|    Configured Just for You     |                    Modify backend settings as preferred for an optimized user experience.                    |  <img src="assets/img/setting.png" width="270px" height="550px"/>  |
+|         Real-Time Data         |                                 Stay updated with real-time data reflecting in your responses.                                  | <img src="assets/img/real-time.png" width="270px" height="550px"/> |
 
-### Contributing
+## Compatibility 🤝
+Our Android app is designed with a broad compatibility range, supporting various Android versions. Regardless of the device you own, RisingBrain Android ensures a seamless, advanced, and user-centric experience.
 
-Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
+## Contributing 💪
+We appreciate your interest in enhancing our work! Please respect the style and contribution guidelines of every project when submitting patches and additions. Our general Git workflow of choice is "fork-and-pull".
 
- 1. **Fork** the repo on GitHub
- 2. **Clone** the project to your own machine
- 3. **Commit** changes to your own branch
- 4. **Push** your work back up to your fork
- 5. Submit a **Pull request** so that we can review your changes
+ 1. **Fork** the repository on GitHub
+ 2. **Clone** your fork to your machine
+ 3. **Commit** the changes to your personal branch
+ 4. **Push** these updates back to your fork
+ 5. Don't forget to submit a **Pull Request** for us to study your contributions.
 
-NOTE: Be sure to merge the latest from "upstream" before making a pull request!
+NOTE: Sync with "upstream" to have the latest updates before you make a pull request!

Brain/README.md

@@ -11,71 +11,60 @@ pinned: false
 license: other
 ---
 
-# 🧠 RisingBrain: Your Future-Forward AI-Powered OS 🚀
+# 🧠 RisingBrain - Powering Your AI Enhanced OS 💡
 
-<p align='center'>
-  <img align='center' src='assets/img/logo.png' width='70%' />
-    <p align='center'>🧠 <b>RisingBrain</b>: Your Future-Forward AI-Powered OS 🚀</p>
+Welcome to the heartbeat of **RisingBrain**, our main backend component. ⚽ Kickstart your **RisingBrain** project right from here.
+<p align="center">
+  <img align="center" src="assets/img/brain-diagram.png" width="100%">
 </p>
 
-**Notice:** *This codebase is under active development and has been recently made public. Please expect frequent updates.*
-
-<p>Are you tired of your dull and monotonous operating system? Say hello to <b>RisingBrain</b>!</p>
-<p>Our project is aimed at revolutionizing how complex software, including operating systems, leverage machine learning. Imagine an OS where an AI manages all apps via fun and interactive plugins, operating as OpenAI plugins or within our backend.</p>
-Sounds exciting?😂 Let's dive into it! 🏊‍♂️
+## Getting Started 🏁
 
-## 1. Look What We've Achieved! 🏆
+The first step involves setting up the necessary environment. You'll need two files:
 
-<p align='center'>
-  <img align='center' src='assets/img/instruction.png' width='88%' />
-  <img align='center' src='assets/img/android_desc.png' width='100%' />
-  <img align='center' src='assets/img/extension&watch.png' width='88%' />
+1. **Firebase Credential JSON file**: Place your firebase_credential.json in the following directory:
+<p align="center">
+  <img src="assets/img/firebase_credential.png" width="88%"/>
+  <p align="center">[Project Directory]/Brain/firebase_credential.json</p>
 </p>
 
-Key features of **RisingBrain** that will make you fall in love with your OS all over again:
-
-- 📱 **Mobile-First Attitude**: 
-    - **Say hello🙋‍♀️ to your intelligent OS** with a smart chat interface that can control all your phone apps via conversational prompts. Powered by state-of-the-art language models like <a href="https://openai.com/research/gpt-4">GPT-4</a>, <a href="https://autogpt.net/">AutoGPT</a>, <a href="https://huggingface.co/blog/falcon">Falcon</a>, <a href="https://huggingface.co/spaces/NeuralInternet/BabyAGI">BabyAGI</a>, <a href="https://en.wikipedia.org/wiki/BERT_(language_model)">BERT</a>, <a href="https://huggingface.co/docs/transformers/model_doc/t5">T5</a> and more, our chatbot is a league apart!
-    - **Control is in your hands🖐**: Manage contacts, images, audio, videos, documents, and even your browsers like <em>Chrome</em>, <em>Firefox</em>, and <em>Safari</em> all from a single app.
-    - **Real-time data at your fingertip👆**: Whether it's news, weather, financial status, or sending emails - we've got you covered.
-    - **Confused with text images or need answers based on PDFs?** Our robust <a href="https://www.onlineocr.net/">OCR</a> functionality is at your service.
-    - **Backend? Your choice**: You decide where to route the backend - set up and manage a range of cloud services like <a href="https://openai.com/">OpenAI</a> and <a href="https://firebase.google.com/">Firebase</a>.
-    - Available on both **Android and iOS**, it's also geared to manage your calendar and alarms. Ultimate ease, don't you think😉?
-- 🌍 **Universal Browser Extension**: 
-    - Meet your new web companion, compatible with browsers like <em>Chrome</em>, <em>Safari</em>, <em>Firefox</em>, etc. Not just for general chat, it's adept at handling several browser functionalities based on your prompts.
-    - Tasks?🤨 Consider them done: From sending emails, booking tables, scheduling appointments, to calendar management - it does it all!
-- ⌚ **Apple to the Rescue**: 
-    - Your favorite general chat is now on Apple Watch. Better yet, it enables you to control your Android app, including contacts and images.
-    - Never be apart: Left your phone at home? No worries👌, control your Android phone right through the app on your Apple Watch – even find contacts!
-
+2. **Environment Variable file**: The .env file is essential for any application configuration. Make sure to have it at the location:
 <p align="center">
-<b><em>How to access us</em></b>:  <a href="https://github.com/ttt246/Brain/tree/main/Brain">Brain🧠</a> | <a href="https://github.com/ttt246/Brain/tree/main/Android">Android Application📱</a> | <a href="https://github.com/ttt246/Brain/tree/main/Extension">Browser Extension🔍</a> | <a href="https://github.com/ttt246/Brain/tree/main/WatchApp">Apple Watch⌚</a>
+  <img src="assets/img/dotenv.png" width="88%"/>
+  <p align="center">[Project Directory]/.env</p>
 </p>
 
-## 2. Functionalities You Need to Check Out 🚀
-
-**RisingBrain** doesn't just look good, it's super smart too! Here's what it can do:
-
-- 📱 **Android App**: 
-    - **Cosy Convos**: Simplify life with general chats with our Rising AI.
-    - **Swift Browsing**: Swiftly access any piece of information on the internet within seconds.
-    - **Image Hunt**: Search for images effortlessly using visual references or descriptive prompts.
-    - **Momentary Contact Search**: Get in touch with any contact quickly and efficiently.
-    - **Text on the Go**: Send SMS messages instantly without leaving your current app environment.
-    - **Up-to-the-Minute** Notifications: Set alarms for appointments or deadlines and let us remind you.
-    - **Email Made Easy**: Compose and send emails seamlessly right from our interface.
-    - **Backend Configuration**: Modify backend settings as needed for an optimized user experience.
-    - **Never Miss a Beat**: Real-time data updations to keep you at the forefront of information.
-- ➡️ **Browser Extension**:
-    - **Tailored Chats**: Enjoy meaningful conversations with Rising AI, customized based on current website's data.
-    - **Controlling the Browser**: Perform actions like opening new tabs, searching the web, scrolling to top/bottom, navigating to next/previous page, or selecting items.
-    - **Seamless Reservations**: Booking a table at your favourite restaurant is just a command away!
-    - **Gmail Integration**: Get your emails sent directly from your current browsing interface.
-- ⌚ **Apple Watch App**:
-    - **Chit-Chats Anywhere**: Have the luxury of general chats with Rising AI right from your wrist.
-    - **Android Abode**: Control your Android device, performing actions like searching contacts or images without reaching for your phone.
-
-## 3. Contributing 💪
+## Running FastAPI Application 🚀
+Our backend runs on a <a href="https://fastapi.tiangolo.com/">FastAPI</a> application. Here's a quick guide to get it up and running:
+
+### Step 1: Create the virtual environment.
+This aims to isolate your Python/system install from the application's project packages.
+
+- On Windows:
+
+  `python -m venv [virtualenv name]\`
+
+  `venv\Scripts\activate.bat\`
+
+- On Linux:
+
+  `python3 -m venv [virtualenv name]`
+
+  `source [virtualenv name]/bin/activate`
+
+
+### Step 2: Install all required packages using the provided requirements.txt file.
+
+`pip install -r requirements.txt`
+
+### Step 3: Start the FastAPI application with hot reloads enabled using Uvicorn.
+`uvicorn app:app --reload`
+
+Bravo!👏 You should now see your **Brain Backend** is alive and ready for action, empowering your AI interactions in **RisingBrain**.
+
+Happy coding! 🎉
+
+## Contributing 💪
 We appreciate your interest in enhancing our work! Please respect the style and contribution guidelines of every project when submitting patches and additions. Our general Git workflow of choice is "fork-and-pull".
 
  1. **Fork** the repository on GitHub

README.md

@@ -62,7 +62,7 @@ Key features of **RisingBrain** that will make you fall in love with your OS all
     - **Image Hunt**: Search for images effortlessly using visual references or descriptive prompts.
     - **Momentary Contact Search**: Get in touch with any contact quickly and efficiently.
     - **Text on the Go**: Send SMS messages instantly without leaving your current app environment.
-    - **Up-to-the-Minute** Notifications: Set alarms for appointments or deadlines and let us remind you.
+    - **Up-to-the-Minute Notifications**: Set alarms for appointments or deadlines and let us remind you.
     - **Email Made Easy**: Compose and send emails seamlessly right from our interface.
     - **Backend Configuration**: Modify backend settings as needed for an optimized user experience.
     - **Never Miss a Beat**: Real-time data updations to keep you at the forefront of information.