Skip to content

Commit c25f58a

Browse files
committed
feat(hackathon): update hackathon page
1 parent 28a69cb commit c25f58a

File tree

2 files changed

+71
-22
lines changed

2 files changed

+71
-22
lines changed

docs/verifiable-ai-hackathon/0-onboarding-guide.mdx renamed to docs/hackathon/0-onboarding.mdx

Lines changed: 67 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 1
33
unlisted: true
4-
slug: onboarding-guide
4+
slug: onboarding
55
title: Onboarding
66
description: Step-by-step guide for setting up infrastructure, credentials, and cloud instances for the Verifiable AI Hackathon.
77
keywords: [flare, ai, confidential-compute, hackathon, google-cloud, onboarding]
@@ -20,32 +20,55 @@ import AddMetaData from "/static/img/verifiable-ai-hackathon/add-metadata.png";
2020

2121
# Onboarding
2222

23-
Welcome to the Verifiable AI Hackathon! This comprehensive guide will walk you through setting up your development environment, including Google Cloud infrastructure, API credentials, and Confidential Compute virtual machines.
23+
Welcome to the **Verifiable AI Hackathon**!
24+
This comprehensive guide will walk you through setting up your development environment, including Google Cloud infrastructure, API credentials, and Confidential Space virtual machines.
2425

2526
## Before You Begin
2627

2728
- Plan for approximately 30-45 minutes to complete the entire setup
2829
- Keep track of your credentials in a secure location
29-
- If you encounter any issues, reach out to the support team via the hackathon Discord channels
30+
- If you encounter any issues, reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh)
3031

3132
## Prerequisites
3233

3334
### Required Google Account & Registration
3435

3536
- Use an existing Google account or create a new one
3637
- This account will be your primary access point for all hackathon resources
37-
- Submit your Google account email during the registration process
38-
- You'll receive access to the `google-hackathon-project` when approved, usually within a hour of submission
38+
- Submit your Google account email during the hackathon registration process
39+
- You'll receive access to the `google-hackathon-project` when approved
3940

4041
### Setting up Gemini API access
4142

42-
1. Log into your registered Google account
43-
1. Visit the [Get a Gemini API key in Google AI Studio](https://aistudio.google.com/app/apikey) page
43+
1. Log into your registered Google account after you receive the approval
44+
1. Visit the [Get a Gemini API key](https://aistudio.google.com/app/apikey) page
4445
1. Click on **Create API key**
4546
1. Select `google-hackathon-project` from the dropdown
4647
1. Click **Create API key in existing project**
4748
1. Store your API key securely
4849

50+
:::tip[Adding Hackathon API keys to your environment]
51+
52+
Add the following lines to your shell configuration file (`~/.bashrc` or `~/.zshrc`):
53+
54+
```bash
55+
export GEMINI_API_KEY=<your-gemini-api-key>
56+
```
57+
58+
Apply the configuration:
59+
60+
```bash
61+
source ~/.bashrc # or source ~/.zshrc, you can also restart the shell
62+
```
63+
64+
Verify:
65+
66+
```bash
67+
echo $GEMINI_API_KEY # Expected output: <your-gemini-api-key>
68+
```
69+
70+
:::
71+
4972
## Setting up a VM
5073

5174
### Option A: Using gcloud CLI (Recommended)
@@ -56,7 +79,7 @@ Follow these steps to set up a GCP instance using Confidential Space with Cloud
5679

5780
1. **Install the gcloud CLI**
5881

59-
- Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS
82+
Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS
6083

6184
2. **Authenticate your CLI**
6285

@@ -68,7 +91,14 @@ Follow these steps to set up a GCP instance using Confidential Space with Cloud
6891

6992
#### Create VM Instance
7093

71-
Use the following command template, replacing the placeholder variables (`<>`):
94+
:::warning[Number of VM instances]
95+
96+
Each hackathon team is limited to **one** continuously running VM.
97+
You can briefly set up more than one instance for testing, but make sure you don't leave it running.
98+
99+
:::
100+
101+
Use the following command template, replacing the highlighted placeholder variables (`<>`):
72102

73103
```bash
74104
# highlight-next-line
@@ -99,9 +129,9 @@ gcloud compute instances create <INSTANCE_NAME> \
99129

100130
**Required Variables:**
101131

102-
- `<INSTANCE_NAME>`: Your instance name (in the format `<project-name>-<team-name>`, e.g. `agent-gemini-team1`)
103-
- `<IMAGE_URL>`: Image path (e.g., `ghcr.io/flare-foundation/flare-ai-core:main`)
104-
- `<ENV_VAR_NAME1>` and `<ENV_VAR_VALUE1>`: First environment variable name (e.g., GEMINI_API_KEY) and first environment variable value
132+
- `<INSTANCE_NAME>`: Your instance name in the format `<project-name>-<team-name>`, e.g. `agent-gemini-team1`
133+
- `<IMAGE_URL>`: Image path (e.g., `ghcr.io/flare-foundation/flare-ai-defai:main`)
134+
- `<ENV_VAR_NAME1>` and `<ENV_VAR_VALUE1>`: First environment variable name (e.g. `GEMINI_API_KEY`) and first environment variable value
105135
- Add additional comma separated environment variables as needed
106136

107137
### Option B: Using GCP Console
@@ -111,7 +141,7 @@ Follow these steps to create your VM instance through the Google Cloud Console i
111141
1. **Initial Setup**
112142

113143
- Navigate to the [GCP Console](https://console.cloud.google.com/)
114-
- Make sure _google-hackathon-project_ is selected
144+
- Make sure **google-hackathon-project** is selected
115145
- Click **Compute Engine → VM instances → Create Instance**
116146

117147
<div align="center">
@@ -125,7 +155,7 @@ Follow these steps to create your VM instance through the Google Cloud Console i
125155
2. **Machine Configuration**
126156

127157
- Name: `<project-name>-<team-name>` (e.g., `agent-gemini-team1`)
128-
- Region: `us-west2`
158+
- Region: `us-central1-c`
129159
- Machine Type: `n2d-standard-2`
130160

131161
<div align="center">
@@ -184,12 +214,11 @@ Follow these steps to create your VM instance through the Google Cloud Console i
184214
- Click **Add Item** under Metadata
185215
- Add the following key-value pairs:
186216

187-
```bash
188-
tee-image-reference: <ghcr.io/john/agent-gemini:main>
189-
tee-container-log-redirect: cloud_logging
190-
```
191-
192-
- Additional API keys should be prefixed with `tee-env-`, e.g. the env variable `GEMINI_API_KEY` will become `tee-env-GEMINI_API_KEY`
217+
| Key | Value | Notes |
218+
| ---------------------------- | ------------------ | --------------------------------------------------- |
219+
| `tee-image-reference` | `<IMAGE_URL>` | e.g. `ghcr.io/flare-foundation/flare-ai-defai:main` |
220+
| `tee-container-log-redirect` | `true` | Sends VM logs to serial port and cloud logging |
221+
| `tee-env-<ENV_VAR_NAME1>` | `<ENV_VAR_VALUE1>` | e.g. `tee-env-GEMINI_API_KEY : MY_GEMINI_API_KEY` |
193222

194223
<div align="center">
195224
<img
@@ -218,8 +247,26 @@ Follow these steps to create your VM instance through the Google Cloud Console i
218247
/>
219248
</div>
220249

250+
## Track Templates
251+
252+
You can use the following track templates to quickly get started building:
253+
254+
| Track | Template Repository | Summary |
255+
| ---- | -------- | ----- |
256+
| Social AI Agents | [flare-foundation/flare-ai-social](https://github.com/flare-foundation/flare-ai-social)
257+
| RAG Knowledge | [flare-foundation/flare-ai-rag](https://github.com/flare-foundation/flare-ai-social)
258+
| AI x DeFi (DeFAI) | [flare-foundation/flare-ai-defai](https://github.com/flare-foundation/flare-ai-defai)
259+
| Consensus Learning | [flare-research/flare-ai-rag](https://github.com/flare-foundation/flare-ai-social)
260+
221261
## Troubleshooting
222262

263+
:::tip[Reach out for support]
264+
265+
If you are unable to bugfix your issue, feel free to reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) for support.
266+
When reaching out clearly mention the VM instance name.
267+
268+
:::
269+
223270
- **VM Creation Fails**
224271
- Verify project permissions
225272
- Check quota limits

sidebars.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ const sidebars: SidebarsConfig = {
1616
{
1717
type: "category",
1818
label: "Verifiable AI Hackathon",
19+
link: {
20+
type: "generated-index",
21+
},
1922
collapsed: true,
20-
link: { type: "doc", id: "verifiable-ai-hackathon/onboarding-guide" },
21-
items: ["verifiable-ai-hackathon/onboarding-guide"],
23+
items: [{ type: "autogenerated", dirName: "hackathon" }],
2224
},
2325
{
2426
type: "category",

0 commit comments

Comments
 (0)