Skip to content

Commit 69ecab8

Browse files
authored
Merge pull request #9 from fredsa/patch-readme
Fix `ng run …` command, and minor `README.md` updates
2 parents 949dd09 + 5549ca1 commit 69ecab8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For more information on Angular, visit [angular.dev](https://angular.dev/).
2020

2121
1. Create a personal fork of the project on GitHub, then clone the fork on your local machine.
2222
1. Run `npm run i` to install the dependencies required to run the server.
23-
1. [IMPORTANT!!] This demo needs a Gemini API to run. Go to [Google AI Studio](https://aistudio.google.com/app/apikey) to get an API key then add it to the Firebase Function in `angular-docs-rag-sample/functions/.env`. This demo simulates how you might store and protect a private Gemini API key in a real world app.
24-
1. [IMPORTANT!!] This demo relies on a `CORPUS_NAME` from Docs Agent, then authenticates with a `service_account_key.json`. See [DocsAgent Set Up guide](https://github.com/google/generative-ai-docs/tree/main/examples/gemini/python/docs-agent#set-up-docs-agent) to set up your own corpus and authentication. You'll need to replace `angular-docs-rag-sample/functions/service_account_key.json` with the one provided to you by Google Cloud, and then make sure to march the `CORPUS_NAME` in `angular-docs-rag-sample/functions/` to your uploaded corpus id.
25-
1. Run `ng run s` to run the server. Since we're using Firebase Functions, you'll need to run our functions and the app in a Firebase Emulator, this command does this automatically!
23+
1. [IMPORTANT!!] This demo needs a Gemini API to run. Go to [Google AI Studio](https://aistudio.google.com/app/apikey) to get an API key then add it to the Firebase Function in `functions/.env`. This demo simulates how you might store and protect a private Gemini API key in a real world app.
24+
1. [IMPORTANT!!] This demo relies on a `CORPUS_NAME` from Docs Agent, then authenticates with a `service_account_key.json`. See [DocsAgent Set Up guide](https://github.com/google/generative-ai-docs/tree/main/examples/gemini/python/docs-agent#set-up-docs-agent) to set up your own corpus and authentication. You'll need to replace `functions/service_account_key.json` with the one provided to you by Google Cloud, and then make sure to march the `CORPUS_NAME` in `functions/` to your uploaded corpus id.
25+
1. Run `ng run angular-chatbot:serve` to run the server. Since we're using Firebase Functions, you'll need to run our functions and the app in a Firebase Emulator, this command does this automatically!
2626
1. Open a browser tab to [http://localhost:4200](http://localhost:4200). The app will automatically reload if you change any of the source files.

0 commit comments

Comments
 (0)