You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# OLAF (Open Life Science Analysis Framework)
2
2
3
-
Welcome to **OLAF (Open Life Science Analysis Framework)**!
3
+
Welcome to **OLAF (Open Life Science Analysis Framework)**!
4
+
5
+

4
6
5
7
OLAF is designed to streamline bioinformatics and computational biology workflows with an easy-to-use frontend and backend setup. This repository includes helper scripts to **quickly configure, start, and stop** OLAF with minimal effort.
6
8
@@ -11,7 +13,9 @@ OLAF is designed to streamline bioinformatics and computational biology workflow
11
13
Before setting up OLAF, ensure you have the required **API keys** and **software dependencies** installed.
12
14
13
15
### **API Keys**
16
+
14
17
OLAF integrates with multiple APIs, so you’ll need to obtain keys for the following services:
18
+
15
19
-**OpenAI API Key** – Required for AI-driven functionalities. Get yours from [OpenAI](https://openai.com).
16
20
-**E2B API Key** – Needed for running isolated cloud environments. Sign up at [E2B](https://e2b.dev).
17
21
-**Google Cloud / Firebase** (Optional) – If you want to use Firebase for hosting or backend functions, you’ll need a **Firebase project** with an API key.
@@ -21,7 +25,9 @@ During setup, the script will prompt you to enter these API keys. If you don’t
21
25
---
22
26
23
27
### **Software Dependencies**
28
+
24
29
To run OLAF, install the following software:
30
+
25
31
-**Docker** – Required for running isolated backend services. Install it from [Docker’s website](https://www.docker.com/get-started).
26
32
-**Node.js & npm** – Needed for frontend and backend dependencies. Install from [Node.js](https://nodejs.org).
27
33
-**Firebase CLI** (if using Firebase) – Install it using:
@@ -33,21 +39,24 @@ To run OLAF, install the following software:
33
39
Ensure all dependencies are installed before running the setup scripts.
34
40
35
41
---
42
+
36
43
## **Getting Started**
37
-
To set up and run OLAF, follow the steps below.
44
+
45
+
To set up and run OLAF, follow the steps below.
38
46
39
47
### **1. Setup Backend**
48
+
40
49
This script will guide you through configuring the backend environment variables (API keys, templates, etc.).
41
50
42
51
```bash
43
52
./setup_backend.sh
44
53
```
45
54
46
55
What it does:
56
+
47
57
* Prompts you for required API keys and configuration values.
48
58
* Creates a .env file in the backend/functions/ directory.
49
59
50
-
51
60
### **1.5. Setup Frontend For Google Cloud (Optional)**
52
61
53
62
This step is only required if you want to use a Google Cloud / Firebase-based setup.
@@ -59,6 +68,7 @@ This step is only required if you want to use a Google Cloud / Firebase-based se
59
68
```
60
69
61
70
What it does:
71
+
62
72
* Prompts you for Firebase and API configurations.
63
73
* Generates an environment.ts file in the frontend/src/environments/ directory.
64
74
* Ensures your frontend is properly linked to Google Cloud.
@@ -74,6 +84,7 @@ Run in Development Mode
74
84
```
75
85
76
86
What it does:
87
+
77
88
* Starts the frontend in development mode.
78
89
* Starts the backend (Firebase) services.
79
90
* Runs both in parallel.
@@ -87,6 +98,7 @@ To stop the backend (and optionally the frontend), run:
87
98
```
88
99
89
100
What it does:
101
+
90
102
* Stops Firebase backend services.
91
103
* Optionally, you can modify this script to kill the frontend process.
92
104
@@ -100,4 +112,4 @@ We ❤️ open-source contributions! If you'd like to contribute:
100
112
4. Push to your fork (`git push origin feature-name`)
101
113
5. Open a pull request 🚀
102
114
103
-
For major changes, please open an issue first to discuss your proposal.
115
+
For major changes, please open an issue first to discuss your proposal.
0 commit comments