Skip to content

Commit

Permalink
js/samples -> js/testapps (#143)
Browse files Browse the repository at this point in the history
  • Loading branch information
tonybaroneee authored May 13, 2024
1 parent 4802f9d commit 3954e7a
Show file tree
Hide file tree
Showing 144 changed files with 20 additions and 20 deletions.
18 changes: 9 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ genkit-tools/cli/src/utils/version.ts
samples/**/pnpm-lock.yaml
genkit-packages
typings
js/samples/firebase-functions-sample1/functions/.env
js/samples/firebase-functions-sample1/.firebase
js/samples/firebase-functions-sample1/.firebaserc
js/samples/firebase-functions-sample1/public/bundle.js
js/samples/firebase-functions-sample1/public/config.js
js/testapps/firebase-functions-sample1/functions/.env
js/testapps/firebase-functions-sample1/.firebase
js/testapps/firebase-functions-sample1/.firebaserc
js/testapps/firebase-functions-sample1/public/bundle.js
js/testapps/firebase-functions-sample1/public/config.js
ui-debug.log
firebase-debug.log

# RAG sample files
!js/samples/rag/package.json
js/samples/rag/*.json
js/samples/cat-eval/__db*.json
js/samples/menu-example/rag/__db*.json
!js/testapps/rag/package.json
js/testapps/rag/*.json
js/testapps/cat-eval/__db*.json
js/testapps/menu/rag/__db*.json

# Test files
last_recording.mp4
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This will produce tarballs in the `dist` folder. Also `genkit-dist.zip` -- a zip

## Link it

You will need the Genkit CLI to run samples and the Developer UI (this is done for you with `pnpm run setup`):
You will need the Genkit CLI to run test apps and the Developer UI (this is done for you with `pnpm run setup`):

```
pnpm link-genkit-cli
Expand All @@ -78,19 +78,19 @@ pnpm link-genkit-cli

### Run a flow

In the `js/samples` folder you will find some samples. They might contain instructions for how to run them and what setup is necessary.
In the `js/testapps` folder you will find some test apps using Genkit. They might contain instructions for how to run them and what setup is necessary.

Here's one that requires no setup:

```
cd js/samples/flow-sample1
cd js/testapps/flow-sample1
genkit flow:run basic "\"hello\""
```

### Run the Developer UI

```
cd js/samples/flow-sample1
cd js/testapps/flow-sample1
genkit start
```

Expand All @@ -105,7 +105,7 @@ To start, let's make sure we have some context to pull from the vector store.
1. Start the Developer UI

```
cd js/samples/rag
cd js/testapps/rag
genkit start
```

Expand All @@ -128,7 +128,7 @@ genkit eval:flow pdfQA '"What's a brief description of MapReduce?"'

FYI: `js` and `genkit-tools` are in two separate workspaces.

As you make changes you may want to build an test things by running samples.
As you make changes you may want to build an test things by running test apps.
You can reduce the scope of what you're building by running a specific build command:

```
Expand Down
2 changes: 1 addition & 1 deletion docs/flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@ export const menuSuggestionFlow = defineFlow(
);
```

See the [sample app](https://github.com/firebase/genkit/blob/main/js/samples/menu-example) that uses the `menuSuggestionFlow`.
See the [test app](https://github.com/firebase/genkit/blob/main/js/testapps/menu) that uses the `menuSuggestionFlow`.
2 changes: 1 addition & 1 deletion go/genkit/testdata/conformance/basic.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "basic",
"_comment": "This is similar to the 'basic' flow in js/samples/flow-sample1",
"_comment": "This is similar to the 'basic' flow in js/testapps/flow-sample1",
"commands": [
{"run": {"name": "call-llm", "command": {"append": "y"}}},
{"run": {"name": "call-llm", "command": {"append": "z"}}}
Expand Down
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "menu",
"version": "1.0.0",
"description": "Samples for a menu understanding app",
"description": "A Genkit test app for understanding a restaurant menu",
"main": "lib/index.js",
"scripts": {
"start": "node lib/index.js",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion samples/js-coffee-shop/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "coffee-shop",
"version": "1.0.0",
"description": "Samples for a coffeeshop",
"description": "Genkit samples for a coffeeshop",
"main": "lib/index.js",
"scripts": {
"start": "node lib/index.js",
Expand Down
2 changes: 1 addition & 1 deletion samples/js-menu/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "menu",
"version": "1.0.0",
"description": "Samples for a menu understanding app",
"description": "Genkit samples for a menu understanding app",
"main": "lib/index.js",
"scripts": {
"start": "node lib/index.js",
Expand Down

0 comments on commit 3954e7a

Please sign in to comment.