Skip to content

Commit a1d7526

Browse files
authored
README updates (#7)
1 parent 04a6157 commit a1d7526

7 files changed

Lines changed: 17 additions & 6 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
### AI Examples
44
* [Vertex AI in Firebase with Angular Starter Kit](./vertex-ai-firebase-angular-example)
5+
* [Genkit with Angular Starter Kit](./genkit-angular-starter-kit/)
6+
* [Genkit + Angular Interactive Graphic Novel Builder](./genkit-angular-story-generator/)
57

68
### Video Tutorial Examples
79
* 🎬 [Getting Started with Standalone Components](https://www.youtube.com/watch?v=x5PZwb4XurU) - [Walk My Dog example application](./walk-my-dog)

genkit-angular-starter-kit/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Firebase Genkit x Angular Starter Kit
1+
# Genkit x Angular Starter Kit
22

3-
This repository contains everything you need to create an application using Firebase Genkit with Angular to build your next great application.
3+
This repository contains everything you need to create an application using Genkit with Angular to build your next great application.
44

55
This example demonstrates how to use Genkit flows to create a persistent chat session with an agent. However, you can use the same patterns
66
in this repository to create an application that runs any arbitrary [Genkit flow](https://firebase.google.com/docs/genkit/flows) you create,
@@ -20,7 +20,7 @@ This example will use the Gemini API which provides a generous free tier and doe
2020
To use the Gemini API, you'll need an API key. If you don't already have one, create a key in Google AI Studio.
2121

2222
1. [Get an API key from Google AI Studio](https://makersuite.google.com/app/apikey)
23-
1. After you’ve created an API key, set the GEMINI_API_KEY environment variable to your key with the command `export GEMINI_API_KEY=<your API key>`
23+
1. After you’ve created an API key, set the `GEMINI_API_KEY` environment variable to your key with the command `export GEMINI_API_KEY=<your API key>`
2424
1. Clone this repository or download the code to your local machine
2525
1. `cd` into the root folder (e.g., `cd genkit-angular-starter-kit`)
2626
1. Install the dependencies with `npm install`
@@ -43,6 +43,15 @@ by the Genkit client.
4343

4444
You can customize this flow or even add new flows following this same pattern. We're excited to see what you build! Happy coding!
4545

46+
## Looking for inspiration?
47+
48+
For a more advanced example of using Genkit with Angular, check out the
49+
[genkit-angular-story-generator repo](../genkit-angular-story-generator/), which is an interactive
50+
graphic novel builder.
51+
52+
Here's an example screenshot from the running application:
53+
![Alt text](../genkit-angular-story-generator/screenshot.png "a screenshot of the running app")
54+
4655
## Genkit Developer UI
4756

4857
The [Genkit Developer UI](https://firebase.google.com/docs/genkit/devtools#genkit_developer_ui) is a local web app that lets you

genkit-angular-story-generator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This example will use the Gemini API which provides a generous free tier and doe
1919
To use the Gemini API, you'll need an API key. If you don't already have one, create a key in Google AI Studio.
2020

2121
1. [Get an API key from Google AI Studio](https://makersuite.google.com/app/apikey)
22-
1. After you’ve created an API key, set the GEMINI_API_KEY environment variable to your key with the command `export GEMINI_API_KEY=<your API key>`
22+
1. After you’ve created an API key, set the `GEMINI_API_KEY` environment variable to your key with the command `export GEMINI_API_KEY=<your API key>`
2323
1. Run `gcloud auth application-default login` to use Vertex AI features
2424
1. Clone this repository or download the code to your local machine
2525
1. `cd` into the root folder (e.g., `cd genkit-angular-story-generator`)
8.03 KB
Loading
-279 KB
Loading

genkit-angular-story-generator/src/app/app.component.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<span>Built with</span>
1313
<img class="logo" ngSrc="/angular.png" width="160" height="50" priority />
1414
<span>+</span>
15-
<img class="logo genkit" ngSrc="/genkit.png" width="239" height="40" priority />
15+
<img class="logo genkit" ngSrc="/genkit.png" width="143" height="55" priority />
1616
</div>
1717
</div>
1818

genkit-angular-story-generator/src/app/app.component.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ p {
6868
}
6969

7070
.genkit {
71-
width: 40%;
71+
width: 28%;
7272
height: auto;
7373
}
7474
}

0 commit comments

Comments
 (0)