Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions learning/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
"customizations": {
"vscode": {
"extensions": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"bradlc.vscode-tailwindcss"
]
}
},
"forwardPorts": [
3000
],
"portsAttributes": {
"3000": {
"label": "Learning App",
"onAutoForward": "notify"
}
},
"postCreateCommand": "npm install",
"postStartCommand": "if [ ! -f .env.local ]; then cp .env.example .env.local && echo '✅ Created .env.local from .env.example.'; fi && echo '🚀 Ready! Run: npm run dev' && echo '📝 Set GOOGLE_API_KEY in .env.local'",
"remoteUser": "node"
}
3 changes: 3 additions & 0 deletions learning/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Google Gemini API Key
# Get your API key from: https://aistudio.google.com/app/apikey
GOOGLE_API_KEY=your_api_key_here
1 change: 1 addition & 0 deletions learning/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ yarn-error.log*

# env files (can opt-in for committing if needed)
.env*
!.env.example

# vercel
.vercel
Expand Down
34 changes: 32 additions & 2 deletions learning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,39 @@ learning/
└── NOTES.md # Detailed design documentation
```

## Getting Started

### Prerequisites
### 🚀 Quick Start with GitHub Codespaces

The fastest way to get started is using GitHub Codespaces - no local setup required!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To make it even easier for users to start a Codespace, you can add an "Open in GitHub Codespaces" badge. This provides a one-click way to launch the environment directly from the README.

Suggested change
The fastest way to get started is using GitHub Codespaces - no local setup required!
The fastest way to get started is using GitHub Codespaces - no local setup required!
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/google-gemini/workshops)


[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/google-gemini/workshops)

1. **Open in Codespaces**
- Navigate to the [workshops repository](https://github.com/google-gemini/workshops)
- Click **Code** → **Codespaces** → **Create codespace on main**
- Wait for the environment to initialize (~2-3 minutes)

2. **Set up your API key**
```bash
# A .env.local file is automatically created for you when the Codespace starts.
# Edit .env.local and add your GOOGLE_API_KEY from https://aistudio.google.com/app/apikey
```

3. **Start the development server**
```bash
npm run dev
```

4. **Open the app**
- VSCode will show a notification to open the forwarded port
- Click **Open in Browser** or navigate to the **Ports** tab

That's it! The application is now running in your browser. 🎉

---

### Prerequisites (Local Development)


- Node.js 18+ and npm
- Google API Key with access to Gemini API
Expand Down