add instructions to readme
Browse files
README.md
CHANGED
|
@@ -14,12 +14,19 @@ Follow these steps to set up and deploy your application on [Beam](https://beam.
|
|
| 14 |
|
| 15 |
---
|
| 16 |
|
| 17 |
-
## 1.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
Sign up at [Beam](https://platform.beam.cloud/).
|
| 19 |
|
| 20 |
---
|
| 21 |
|
| 22 |
-
##
|
| 23 |
Create and activate a Python virtual environment:
|
| 24 |
```shell
|
| 25 |
python3 -m venv .venv && source .venv/bin/activate
|
|
@@ -27,7 +34,7 @@ python3 -m venv .venv && source .venv/bin/activate
|
|
| 27 |
|
| 28 |
---
|
| 29 |
|
| 30 |
-
##
|
| 31 |
Install the dependencies listed in the `requirements.txt` file:
|
| 32 |
```shell
|
| 33 |
pip install -r requirements.txt
|
|
@@ -35,7 +42,7 @@ pip install -r requirements.txt
|
|
| 35 |
|
| 36 |
---
|
| 37 |
|
| 38 |
-
##
|
| 39 |
Retrieve your API token from the [API Keys](https://platform.beam.cloud/settings/api-keys) page on the Beam dashboard. Then, configure Beam with your token:
|
| 40 |
```shell
|
| 41 |
beam configure default --token [TOKEN]
|
|
@@ -43,7 +50,7 @@ beam configure default --token [TOKEN]
|
|
| 43 |
|
| 44 |
---
|
| 45 |
|
| 46 |
-
##
|
| 47 |
Deploy your application using the following command:
|
| 48 |
```shell
|
| 49 |
beam deploy app.py:server
|
|
@@ -51,7 +58,7 @@ beam deploy app.py:server
|
|
| 51 |
|
| 52 |
---
|
| 53 |
|
| 54 |
-
##
|
| 55 |
Make a POST request to your deployed stream endpoint:
|
| 56 |
```shell
|
| 57 |
curl -X POST 'https://[ID].app.beam.cloud/stream' \
|
|
@@ -63,7 +70,7 @@ curl -X POST 'https://[ID].app.beam.cloud/stream' \
|
|
| 63 |
|
| 64 |
---
|
| 65 |
|
| 66 |
-
##
|
| 67 |
Enjoy 15 hours of free trial usage on Beam!
|
| 68 |
|
| 69 |
---
|
|
|
|
| 14 |
|
| 15 |
---
|
| 16 |
|
| 17 |
+
## 1. Clone the repository
|
| 18 |
+
```shell
|
| 19 |
+
git clone https://huggingface.co/spaces/Error410/beam-app
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
---
|
| 23 |
+
|
| 24 |
+
## 2. Create an Account on Beam
|
| 25 |
Sign up at [Beam](https://platform.beam.cloud/).
|
| 26 |
|
| 27 |
---
|
| 28 |
|
| 29 |
+
## 3. Set Up a Python Virtual Environment
|
| 30 |
Create and activate a Python virtual environment:
|
| 31 |
```shell
|
| 32 |
python3 -m venv .venv && source .venv/bin/activate
|
|
|
|
| 34 |
|
| 35 |
---
|
| 36 |
|
| 37 |
+
## 4. Install Required Packages
|
| 38 |
Install the dependencies listed in the `requirements.txt` file:
|
| 39 |
```shell
|
| 40 |
pip install -r requirements.txt
|
|
|
|
| 42 |
|
| 43 |
---
|
| 44 |
|
| 45 |
+
## 5. Register Your Beam API Token
|
| 46 |
Retrieve your API token from the [API Keys](https://platform.beam.cloud/settings/api-keys) page on the Beam dashboard. Then, configure Beam with your token:
|
| 47 |
```shell
|
| 48 |
beam configure default --token [TOKEN]
|
|
|
|
| 50 |
|
| 51 |
---
|
| 52 |
|
| 53 |
+
## 6. Deploy Your Application on Beam
|
| 54 |
Deploy your application using the following command:
|
| 55 |
```shell
|
| 56 |
beam deploy app.py:server
|
|
|
|
| 58 |
|
| 59 |
---
|
| 60 |
|
| 61 |
+
## 7. Call the Stream Endpoint
|
| 62 |
Make a POST request to your deployed stream endpoint:
|
| 63 |
```shell
|
| 64 |
curl -X POST 'https://[ID].app.beam.cloud/stream' \
|
|
|
|
| 70 |
|
| 71 |
---
|
| 72 |
|
| 73 |
+
## 8. Enjoy Your Free Trial
|
| 74 |
Enjoy 15 hours of free trial usage on Beam!
|
| 75 |
|
| 76 |
---
|