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: docs/hackathon/0-onboarding.mdx
+52-39Lines changed: 52 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ import CreateKey from "/static/img/verifiable-ai-hackathon/create-key.png";
17
17
# Onboarding
18
18
19
19
Welcome to the **Verifiable AI Hackathon**!
20
-
This guide will walk you through setting up your development environment, including Google Cloud infrastructure, API credentials, and Confidential Space virtual machines.
20
+
This guide will walk you through setting up your development environment, including Google Cloud infrastructure, API credentials, and gcloud CLI access.
21
21
22
22
## Before You Begin
23
23
@@ -28,19 +28,19 @@ This guide will walk you through setting up your development environment, includ
28
28
29
29
### Prerequisites
30
30
31
-
-An existing Google account or create a new one
31
+
-A Google account (existing or newly created)
32
32
- This account will be your primary access point for all hackathon resources
33
33
34
34
### Registration Process
35
35
36
-
1. Submit your Google account email during hackathon registration
37
-
2. Access to the `verifiable-ai-hackathon` project will be granted on March 6th (one day before the hackathon)
38
-
3. Verify your access by visiting the [GCP Console](https://console.cloud.google.com/welcome?project=verifiable-ai-hackathon)
36
+
1. Submit your Google account email during hackathon registration (i.e. the Google Form you submitted)
37
+
2. Access to the `verifiable-ai-hackathon`Google Cloud project will be granted on **March 6th** (one day before the hackathon)
38
+
3. Verify your access by visiting the [Google Cloud Console](https://console.cloud.google.com/welcome?project=verifiable-ai-hackathon)
39
39
4. When access is granted, you'll see this confirmation screen:
40
40
41
41
<imgsrc={AccessGranted}style={{ width: 600 }} />
42
42
43
-
## Step 2: Setting up API keys
43
+
## Step 2: API Credential Setup
44
44
45
45
### Gemini API Keys
46
46
@@ -56,54 +56,46 @@ This guide will walk you through setting up your development environment, includ
56
56
57
57
5. Store your API key securely
58
58
59
-
:::tip[Common API Key Issues]
59
+
### OpenRouter API Keys (Consensus Learning Track Only)
60
60
61
-
If you are unable to create an API key, or the `verifiable-ai-hackathon` doesn't show up in the dropdown.
61
+
If you're participating in the Consensus Learning track:
62
62
63
-
- Ensure you're logged into the correct Google account
64
-
- Wait a few minutes after project approval before attempting
65
-
- Reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh)
66
-
67
-
:::
68
-
69
-
### OpenRouter API Keys (Consensus Learning Track)
70
-
71
-
For participants in the Consensus Learning track:
72
-
73
-
1. Visit [OpenRouter](https://openrouter.ai)
74
-
2. Create a free account
75
-
3. Set up API keys on the [Settings page](https://openrouter.ai/settings/keys)
76
-
4. For higher credit limits, contact the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) with your team and VM instance name
63
+
1. Visit [OpenRouter](https://openrouter.ai) and create a free account
64
+
2. Navigate to the [Settings page](https://openrouter.ai/settings/keys) to generate your API keys
65
+
3.**Need higher limits?** Contact the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) with your team and VM instance name
77
66
78
67
## Step 3: Set up gcloud CLI
79
68
80
-
1.**Install the gcloud CLI**
69
+
1.**Download & install the gcloud CLI**
81
70
82
-
Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS
71
+
- Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS
72
+
- Installation packages available for Windows, macOS, and Linux
83
73
84
-
Verify installation:
74
+
2.**Verify installation:**
85
75
86
76
```bash
87
77
gcloud version
88
78
```
89
79
90
-
2.**Authenticate your CLI**
80
+
3.**Authenticate your CLI**
91
81
92
82
Use the same account used for hackathon registration
93
83
94
84
```bash
95
85
gcloud auth login
96
86
```
97
87
98
-
Verify project access:
88
+
4.**Verify project access:**
99
89
100
90
```bash
101
-
gcloud projects list# Should show verifiable-ai-hackathon
91
+
gcloud projects list
102
92
```
103
93
104
-
## Step 4: Choose a Track Template
94
+
The output should include `verifiable-ai-hackathon`
95
+
96
+
## Step 4: Track template selection
105
97
106
-
1. Jump-start your development with one of these pre-configured templates,
98
+
1. Jump-start your development with one of these pre-configured templates:
@@ -116,20 +108,41 @@ For participants in the Consensus Learning track:
116
108
117
109
<imgsrc={ChooseTemplate}style={{ width: 300 }} />
118
110
119
-
3. Clone the repo:
111
+
3.**Clone the repo:**
120
112
121
-
```bash
122
-
git clone YOUR_REPO
123
-
cd YOUR_REPO
124
-
```
113
+
```bash
114
+
git clone https://github.com/YOUR_REPO
115
+
cd YOUR_REPO
116
+
```
117
+
118
+
4. Follow the **README** in your chosen template for track-specific setup instructions
119
+
120
+
Happy hacking!
125
121
126
122
## Troubleshooting
127
123
128
-
-**Using gcloud CLI on Windows:** On Windows, you need to use the gcloud CLI to run gcloud commands.
124
+
-**Unable to create Gemini API Key in `verifiable-ai-hackathon`:**
125
+
126
+
- Ensure you're logged into the exact Google account you registered with (i.e. the Google Form you submitted)
127
+
- Wait 5-10 minutes after receiving project access before attempting
128
+
- Clear browser cache or try in a private/incognito window
129
+
130
+
-**gcloud CLI Authentication Problems:**
131
+
132
+
- Run gcloud auth login --no-launch-browser if the browser auth flow fails
133
+
- Check if you have multiple Google accounts in your browser and select the correct one
134
+
135
+
-**Windows-specific gcloud issues**
136
+
- On Windows, when installing the gcloud CLI, gcloud installs its own basic shell as well.
137
+
- We recommend using [git BASH](https://gitforwindows.org) for access to a full set of linux commands.
138
+
139
+
:::tip[Still not able to bugfix?]
129
140
130
-
:::tip[Still not able to bigfix?]
141
+
If you are unable to fix your issue, feel free to reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) for support. When reaching out, include:
131
142
132
-
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.
133
-
When reaching out clearly mention the team and VM instance name.
0 commit comments