Alex Newman commited on
Commit
614e1cd
Β·
unverified Β·
2 Parent(s): 4e573d8b722b7e

Merge pull request #242 from ttt246/simplify-readme

Browse files
Files changed (1) hide show
  1. Brain/README.md +2 -41
Brain/README.md CHANGED
@@ -20,55 +20,16 @@ Welcome to the heartbeat of **RisingBrain**, our main backend component. ⚽ Kic
20
 
21
  ## Getting Started 🏁
22
 
23
- The first step involves setting up the necessary environment. You'll need two files:
24
-
25
- 1. **Firebase Credential JSON file**: Place your firebase_credential.json in the following directory:
26
-
27
- <p align="center">
28
- <img src="assets/img/firebase_credential.png" width="88%"/>
29
- <p align="center">[Project Directory]/Brain/firebase_credential.json</p>
30
- </p>
31
-
32
- 2. **Environment Variable file**: The .env file is essential for any application configuration. Make sure to have it at the location:
33
- <p align="center">
34
- <img src="assets/img/dotenv.png" width="88%"/>
35
- <p align="center">[Project Directory]/.env</p>
36
- </p>
37
-
38
  ## Running FastAPI Application πŸš€
39
  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:
40
 
41
- ### Step 1: Create the virtual environment.
42
- This aims to isolate your Python/system install from the application's project packages.
43
-
44
- - On Windows:
45
-
46
- ``` bach
47
- python -m venv [virtualenv name]
48
- ```
49
-
50
- ``` bash
51
- venv\Scripts\activate.bat\
52
- ```
53
-
54
- - On Linux:
55
-
56
- ``` bash
57
- python3 -m venv [virtualenv name]
58
- ```
59
-
60
- ``` bash
61
- source [virtualenv name]/bin/activate
62
- ```
63
-
64
-
65
- ### Step 2: Install all required packages using the provided requirements.txt file.
66
 
67
  ``` bash
68
  pip install -r requirements.txt
69
  ```
70
 
71
- ### Step 3: Start the FastAPI application with hot reloads enabled using Uvicorn.
72
  ``` bash
73
  uvicorn app:app --reload
74
  ```
 
20
 
21
  ## Getting Started 🏁
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  ## Running FastAPI Application πŸš€
24
  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:
25
 
26
+ ### Step 1: Install all required packages using the provided requirements.txt file.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
 
28
  ``` bash
29
  pip install -r requirements.txt
30
  ```
31
 
32
+ ### Step 2: Start the FastAPI application with hot reloads enabled using Uvicorn.
33
  ``` bash
34
  uvicorn app:app --reload
35
  ```