File size: 1,631 Bytes
8ab7dfe
 
 
 
 
 
 
 
 
 
 
 
 
e8a128c
8ab7dfe
e8a128c
 
 
be322d5
 
e8a128c
 
 
b722b7e
e8a128c
e5e7450
 
 
e8a128c
b722b7e
e5e7450
 
 
e8a128c
 
 
 
 
 
be322d5
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
---
title: RisingBrain
emoji: 🌍
colorFrom: yellow
colorTo: indigo
app_file: app.py
sdk: gradio
sdk_version: 2.9.1
python_version: 3.10.4
pinned: false
license: other
---

# 🧠 RisingBrain - Powering Your AI Enhanced OS πŸ’‘

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>

## 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: Install all required packages using the provided requirements.txt file.

  ``` bash
  pip install -r requirements.txt
  ```

### Step 2: Start the FastAPI application with hot reloads enabled using Uvicorn.
  ``` bash
  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
 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: Sync with "upstream" to have the latest updates before you make a pull request!