Skip to content

Commit de2dccc

Browse files
committed
Added demo photo to README
1 parent 2954748 commit de2dccc

2 files changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# OLAF (Open Life Science Analysis Framework)
22

3-
Welcome to **OLAF (Open Life Science Analysis Framework)**!
3+
Welcome to **OLAF (Open Life Science Analysis Framework)**!
4+
5+
![Demo Image](assets/demo_pic.png)
46

57
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.
68

@@ -11,7 +13,9 @@ OLAF is designed to streamline bioinformatics and computational biology workflow
1113
Before setting up OLAF, ensure you have the required **API keys** and **software dependencies** installed.
1214

1315
### **API Keys**
16+
1417
OLAF integrates with multiple APIs, so you’ll need to obtain keys for the following services:
18+
1519
- **OpenAI API Key** – Required for AI-driven functionalities. Get yours from [OpenAI](https://openai.com).
1620
- **E2B API Key** – Needed for running isolated cloud environments. Sign up at [E2B](https://e2b.dev).
1721
- **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
2125
---
2226

2327
### **Software Dependencies**
28+
2429
To run OLAF, install the following software:
30+
2531
- **Docker** – Required for running isolated backend services. Install it from [Docker’s website](https://www.docker.com/get-started).
2632
- **Node.js & npm** – Needed for frontend and backend dependencies. Install from [Node.js](https://nodejs.org).
2733
- **Firebase CLI** (if using Firebase) – Install it using:
@@ -33,21 +39,24 @@ To run OLAF, install the following software:
3339
Ensure all dependencies are installed before running the setup scripts.
3440

3541
---
42+
3643
## **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.
3846

3947
### **1. Setup Backend**
48+
4049
This script will guide you through configuring the backend environment variables (API keys, templates, etc.).
4150

4251
```bash
4352
./setup_backend.sh
4453
```
4554

4655
What it does:
56+
4757
* Prompts you for required API keys and configuration values.
4858
* Creates a .env file in the backend/functions/ directory.
4959

50-
5160
### **1.5. Setup Frontend For Google Cloud (Optional)**
5261

5362
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
5968
```
6069

6170
What it does:
71+
6272
* Prompts you for Firebase and API configurations.
6373
* Generates an environment.ts file in the frontend/src/environments/ directory.
6474
* Ensures your frontend is properly linked to Google Cloud.
@@ -74,6 +84,7 @@ Run in Development Mode
7484
```
7585

7686
What it does:
87+
7788
* Starts the frontend in development mode.
7889
* Starts the backend (Firebase) services.
7990
* Runs both in parallel.
@@ -87,6 +98,7 @@ To stop the backend (and optionally the frontend), run:
8798
```
8899

89100
What it does:
101+
90102
* Stops Firebase backend services.
91103
* Optionally, you can modify this script to kill the frontend process.
92104

@@ -100,4 +112,4 @@ We ❤️ open-source contributions! If you'd like to contribute:
100112
4. Push to your fork (`git push origin feature-name`)
101113
5. Open a pull request 🚀
102114

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.

assets/demo_pic.png

470 KB
Loading

0 commit comments

Comments
 (0)