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
+58-38Lines changed: 58 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,35 +16,34 @@ import CreateKey from "/static/img/verifiable-ai-hackathon/create-key.png";
16
16
17
17
# Onboarding
18
18
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 gcloud CLI access.
19
+
Welcome to the **Verifiable AI Hackathon**! 🎉
20
+
21
+
This guide walks you through the **four-step setup** to ensure you have the necessary access and tools to start building.
21
22
22
23
## Before You Begin
23
24
24
-
-**Time Estimate:** 15-20 minutes to complete the entire setup
25
-
-**Support Channel:**[Telegram Support Group](https://t.me/+StI5VEIvtIg2ODlh)
25
+
-**Estimated Time:**~15-20 minutes
26
+
-**Need Help?** Join our[Telegram Support Group](https://t.me/+StI5VEIvtIg2ODlh)
26
27
27
-
## Step 1: Google Account Setup
28
+
## Step 1: Set up your Google account
28
29
29
30
### Prerequisites
30
31
31
-
- A Google account (existing or newly created)
32
-
- This account will be your primary access point for all hackathon resources
32
+
- A Google account (existing or newly created) - this will be your access point for all hackathon resources
33
33
34
-
### Registration Process
34
+
### Registration & access
35
35
36
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
-
4. When access is granted, you'll see this confirmation screen:
37
+
2. Access to the `verifiable-ai-hackathon` Google Cloud project will be granted on **March 6th** (i.e. 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), when access is granted you will see the following confirmation:
40
39
41
40
<imgsrc={AccessGranted}style={{ width: 600 }} />
42
41
43
-
## Step 2: API Credential Setup
42
+
## Step 2: Set up API credentials
44
43
45
44
### Gemini API Keys
46
45
47
-
1. Log into your registered Google account after you receive the approval
46
+
1. Log into your registered Google account after you receive access to the `verifiable-ai-hackathon` Google Cloud project
48
47
2. Visit the [Get a Gemini API key](https://aistudio.google.com/app/apikey) page
49
48
3. Click on **Create API key** and select `verifiable-ai-hackathon` from the dropdown
50
49
@@ -54,48 +53,61 @@ This guide will walk you through setting up your development environment, includ
54
53
55
54
<imgsrc={CreateKey}style={{ width: 600 }} />
56
55
57
-
5. Store your API key securely
56
+
5.**Store your API key securely**
58
57
59
-
### OpenRouter API Keys (Consensus Learning Track Only)
58
+
<details>
59
+
<summary>OpenRouter API Keys (Consensus Learning Track Only)</summary>
60
60
61
61
If you're participating in the Consensus Learning track:
62
62
63
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
64
+
2. Navigate to the [Settings page](https://openrouter.ai/settings/keys) to generate your free API keys
65
65
3.**Need higher limits?** Contact the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) with your team and VM instance name
66
66
67
-
## Step 3: Set up gcloud CLI
67
+
</details>
68
+
69
+
## Step 3: Install & configure gcloud CLI
68
70
69
-
1.**Download & install the gcloud CLI**
71
+
### Install gcloud CLI
70
72
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
73
+
1. Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) for Windows, macOS, or Linux.
73
74
74
-
2.**Verify installation:**
75
+
2.**Check installation:**
75
76
76
77
```bash
77
78
gcloud version
78
79
```
79
80
80
-
3.**Authenticate your CLI**
81
+
### Authenticate & verify access
81
82
82
-
Use the same account used for hackathon registration
83
+
1.**Authenticate your CLI**
84
+
85
+
Authenticate using the same Google account used for hackathon registration:
83
86
84
87
```bash
85
88
gcloud auth login
86
89
```
87
90
88
-
4.**Verify project access:**
91
+
2.**Verify project access:**
89
92
90
93
```bash
91
94
gcloud projects list
92
95
```
93
96
94
97
The output should include `verifiable-ai-hackathon`
95
98
96
-
## Step 4: Track template selection
99
+
## Step 4: Select your track template
100
+
101
+
### Prerequisites
102
+
103
+
Ensure you have the following tools installed:
97
104
98
-
1. Jump-start your development with one of these pre-configured templates:
2. Navigate to the template, and click on **Use this template** and **Create a new repository**
119
+
### Clone & start building
120
+
121
+
1. Navigate to the template, and click on **Use this template** → **Create a new repository**
108
122
109
123
<imgsrc={ChooseTemplate}style={{ width: 300 }} />
110
124
111
-
3.**Clone the repo:**
125
+
2.**Clone the repo:**
112
126
113
127
```bash
114
128
git clone https://github.com/YOUR_REPO
115
129
cd YOUR_REPO
116
130
```
117
131
118
-
4. Follow the **README** in your chosen template for track-specific setup instructions
132
+
3. Follow the **README** in your chosen template for track-specific setup instructions
119
133
120
-
Happy hacking!
134
+
**Happy building!**
135
+
136
+
:::danger[Using hackathon compute resources]
137
+
138
+
VM instances in `verifiable-ai-hackathon` are continuously monitored.
139
+
140
+
**Any attempt** to use compute resources for activities outside the hackathon will result in immediate instance termination and possible suspension or permanent ban of account access privileges.
141
+
142
+
:::
121
143
122
144
## Troubleshooting
123
145
@@ -129,20 +151,18 @@ Happy hacking!
129
151
130
152
-**gcloud CLI Authentication Problems:**
131
153
132
-
- Run gcloud auth login --no-launch-browser if the browser auth flow fails
154
+
- Run `gcloud auth login --no-launch-browser` if the browser auth flow fails
133
155
- Check if you have multiple Google accounts in your browser and select the correct one
134
156
135
157
-**Windows-specific gcloud issues**
136
158
- On Windows, when installing the gcloud CLI, gcloud installs its own basic shell as well.
137
159
- We recommend using [git BASH](https://gitforwindows.org) for access to a full set of linux commands.
138
160
139
-
:::tip[Still not able to bugfix?]
161
+
## Need Help?
140
162
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:
163
+
If you're stuck, reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh). Include:
0 commit comments