happygold commited on
Commit
be322d5
·
1 Parent(s): 95aeed2

feature(#144): Clean and update Brain readme

Browse files
Brain/README.md CHANGED
@@ -11,49 +11,77 @@ pinned: false
11
  license: other
12
  ---
13
 
14
- # RisingBrain
15
- WIP: This codebase is under active development and recently opened to the public.
16
 
17
- 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.
 
 
 
 
 
 
 
 
 
18
 
19
- ## 1. Description
20
 
21
- #### 1.1 Achievement
22
  <p align='center'>
23
- <img align='center' src='assets/img/desc.png' width='100%' />
 
 
24
  </p>
25
 
26
- - 📱 Support for mobile devices to manage all apps via plugin as its launcher.
27
- - 🌍 Support all web browsers to manipulate it automatically as its extension.
28
- - 🔗 Multiple API support (Web API for Free and Plus users, GPT-3.5, GPT-4, etc.).
29
- - 🔍 Integration to all mainstream search engines, and custom queries to support additional sites.
30
- -
31
- #### 1.2 Feature
32
-
33
- - Chat with Rising AI as an assistant.
34
- - Search something from browser(which installed in your device) with user's input without any additional behaviour automatically.
35
- - Search an image what you want for with its similar image or its description as user's prompt.
36
- - Search a contact automatically and guide a user to have a call or Sms when they want.
37
- - Manage contacts automatically and let a user going to any contact with its name or number.
38
- - Manipulate all browsers with user's input(tab, page, search, scroll, or etc) and it will follow you to go on the real website or blog what you are thinking of.
39
-
40
- ## 2. Installing / Getting started
41
- #### 2.1 how to run on local
42
- It's a standard fastapi application so no configuration is needed beyond the included Procfile
43
- #### 2.2 Create firebase project
44
- Create firebase project and take its credentials named .json from Google Cloude IAM.
45
- #### 2.3 Get Heroku Api key
46
- Deploy it to Heroku in CI/CD automatically whenever there are some changes in main or develop branch.
47
- #### 2.4 Set Github Secrets With its Access Keys
48
- All credentials including openai, replicate and pinecone are shared with Github Secrets to be referenced by Unit Tests of CI/CD on its building
49
-
50
- ## Contributing
51
- 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.
52
-
53
- 1. **Fork** the repo on GitHub
54
- 2. **Clone** the project to your own machine
55
- 3. **Commit** changes to your own branch
56
- 4. **Push** your work back up to your fork
57
- 5. Submit a **Pull request** so that we can review your changes
58
-
59
- NOTE: Be sure to merge the latest from "upstream" before making a pull request!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  license: other
12
  ---
13
 
14
+ # 🧠 RisingBrain: Your Future-Forward AI-Powered OS 🚀
 
15
 
16
+ <p align='center'>
17
+ <img align='center' src='assets/img/logo.png' width='70%' />
18
+ <p align='center'>🧠 <b>RisingBrain</b>: Your Future-Forward AI-Powered OS 🚀</p>
19
+ </p>
20
+
21
+ **Notice:** *This codebase is under active development and has been recently made public. Please expect frequent updates.*
22
+
23
+ <p>Are you tired of your dull and monotonous operating system? Say hello to <b>RisingBrain</b>!</p>
24
+ <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>
25
+ Sounds exciting?😂 Let's dive into it! 🏊‍♂️
26
 
27
+ ## 1. Look What We've Achieved! 🏆
28
 
 
29
  <p align='center'>
30
+ <img align='center' src='assets/img/instruction.png' width='88%' />
31
+ <img align='center' src='assets/img/android_desc.png' width='100%' />
32
+ <img align='center' src='assets/img/extension&watch.png' width='88%' />
33
  </p>
34
 
35
+ Key features of **RisingBrain** that will make you fall in love with your OS all over again:
36
+
37
+ - 📱 **Mobile-First Attitude**:
38
+ - **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!
39
+ - **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.
40
+ - **Real-time data at your fingertip👆**: Whether it's news, weather, financial status, or sending emails - we've got you covered.
41
+ - **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.
42
+ - **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>.
43
+ - Available on both **Android and iOS**, it's also geared to manage your calendar and alarms. Ultimate ease, don't you think😉?
44
+ - 🌍 **Universal Browser Extension**:
45
+ - 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.
46
+ - Tasks?🤨 Consider them done: From sending emails, booking tables, scheduling appointments, to calendar management - it does it all!
47
+ - **Apple to the Rescue**:
48
+ - Your favorite general chat is now on Apple Watch. Better yet, it enables you to control your Android app, including contacts and images.
49
+ - 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!
50
+
51
+ <p align="center">
52
+ <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>
53
+ </p>
54
+
55
+ ## 2. Functionalities You Need to Check Out 🚀
56
+
57
+ **RisingBrain** doesn't just look good, it's super smart too! Here's what it can do:
58
+
59
+ - 📱 **Android App**:
60
+ - **Cosy Convos**: Simplify life with general chats with our Rising AI.
61
+ - **Swift Browsing**: Swiftly access any piece of information on the internet within seconds.
62
+ - **Image Hunt**: Search for images effortlessly using visual references or descriptive prompts.
63
+ - **Momentary Contact Search**: Get in touch with any contact quickly and efficiently.
64
+ - **Text on the Go**: Send SMS messages instantly without leaving your current app environment.
65
+ - **Up-to-the-Minute** Notifications: Set alarms for appointments or deadlines and let us remind you.
66
+ - **Email Made Easy**: Compose and send emails seamlessly right from our interface.
67
+ - **Backend Configuration**: Modify backend settings as needed for an optimized user experience.
68
+ - **Never Miss a Beat**: Real-time data updations to keep you at the forefront of information.
69
+ - ➡️ **Browser Extension**:
70
+ - **Tailored Chats**: Enjoy meaningful conversations with Rising AI, customized based on current website's data.
71
+ - **Controlling the Browser**: Perform actions like opening new tabs, searching the web, scrolling to top/bottom, navigating to next/previous page, or selecting items.
72
+ - **Seamless Reservations**: Booking a table at your favourite restaurant is just a command away!
73
+ - **Gmail Integration**: Get your emails sent directly from your current browsing interface.
74
+ - ⌚ **Apple Watch App**:
75
+ - **Chit-Chats Anywhere**: Have the luxury of general chats with Rising AI right from your wrist.
76
+ - **Android Abode**: Control your Android device, performing actions like searching contacts or images without reaching for your phone.
77
+
78
+ ## 3. Contributing 💪
79
+ 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".
80
+
81
+ 1. **Fork** the repository on GitHub
82
+ 2. **Clone** your fork to your machine
83
+ 3. **Commit** the changes to your personal branch
84
+ 4. **Push** these updates back to your fork
85
+ 5. Don't forget to submit a **Pull Request** for us to study your contributions.
86
+
87
+ NOTE: Sync with "upstream" to have the latest updates before you make a pull request!
Brain/assets/img/android_desc.png ADDED
Brain/assets/img/extension&watch.png ADDED
Brain/assets/img/extension_desc.png ADDED
Brain/assets/img/instruction.png ADDED
Brain/assets/img/logo.png ADDED
Brain/assets/img/watch_desc.png ADDED