-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ea0fd9d
commit 755ffb6
Showing
1 changed file
with
18 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,34 @@ | ||
## [Overview](https://drive.google.com/file/d/1UpjrIJQ4gIcPB6IvEkNNxIwILXevkIaK/view?usp=drive_link) | ||
|
||
In this step we will add streaming capabilities from the NLAPI as well as more functionality to the app by adding recipes, ingredients and a family shopping list. | ||
|
||
In this step we will add streaming capabilities from the NLAPI as well as more functionality to the app by adding recipes, ingredients and a family shopping list. | ||
|
||
## Steps: | ||
|
||
**1. Run npm run update-schema**: to make sure you application has the most updated schema (this will be updated automatically everytime you push to one of the branches in the `.github/workflows/update-schema.yml` file) | ||
**1. Run `npm run seed`** to update the database with new data needed for this stage. | ||
|
||
**2. Run `npm run update-schema`** to make sure your application has the most updated schema (this will be updated automatically every time you push to one of the branches in the `.github/workflows/update-schema.yml` file) | ||
|
||
**2. Test out streamming UI**: Login at localhost:5573, then ask 'What recipes are available?' and watch the reply. | ||
**3. Test out streamming UI**: Login at http://localhost:5573, ask 'What recipes are available?', and watch the reply. | ||
|
||
**3. Try adding a new recipe**: Use the chat to add a new recipe. Go to localhost:5573/recipes to see the new recipe. | ||
**4. Try adding a new recipe**: Use the chat to add a new recipe. Go to http://localhost:5573/recipes to see the new recipe. | ||
|
||
## Features Added: | ||
|
||
- **Streaming Messages**: This allows the message reply look like it's typing back a response | ||
- **Added Endpoints**: Giving the api more functionality by adding recipes, ingredients, and shopping list | ||
If visualizing is helpful. Here is a ERD sample of the current database. | ||
![Database ERD](./assets/erd.png) | ||
- **Streaming Messages**: This allows the message reply look to like it's typing back a response in real time. | ||
- **Added Endpoints**: Gives the api more functionality by adding recipes, ingredients, and shopping list | ||
If visualizing is helpful, here is an ERD sample of the current database. | ||
|
||
![Database ERD](./assets/erd.png) | ||
|
||
## Notes: | ||
- Scroll to bottom Behavior explanation (Comment out `<div ref={messagesEndRef} />` in ChatBubble.jsx and ask the bot a few follow up questions to understand why it's important) | ||
- Displays status messages, you can map responses if needed. | ||
- Note Recipe Ingredient Unique Constraint Error Message. | ||
|
||
- Scroll to bottom behavior explanation (Comment out `<div ref={messagesEndRef} />` in ChatBubble.jsx and ask the bot a few follow up questions to understand why it's important) | ||
- Displays status messages, you can map responses if needed. | ||
- Note Recipe Ingredient Unique Constraint Error Message. | ||
- Note: Current limitation to the Shopping list is that you can only add ingredients from a recipeIngredient | ||
- Remember to run npm run update-schema | ||
- Remember to run `npm run update-schema` | ||
- Added UI - Still have to refresh the page when using chat. Will fix this is stage-4 | ||
|
||
## Common Errors: | ||
**Bot choosing the right endpoints to call**: It's likely that you forgot to run `npm run update-schema` Or something failed in that process. Run the command and check the output for a success message. If you get a success output. Make sure you are sending the correct file and that it has been updated from running `npm run dev`. If everything is correct there, and you are still having issues, please reach out to [email protected] and I'll gladly assist you as needed. | ||
|
||
**Bot choosing the right endpoints to call**: It's likely that you forgot to run `npm run update-schema` Or something failed in that process. Run the command and check the output for a success message. If you get a success output. Make sure you are sending the correct file and that it has been updated from running `npm run dev`. If everything is correct and you are still having issues, please reach out to [email protected], and I'll gladly assist you as needed. |