Merge branch 'langchain-template'

LeooR22 · LeooR22 · commit c5b32c44b044 · 2023-08-28T11:50:26.000-03:00
diff --git a/README.md b/README.md
@@ -13,45 +13,6 @@ After you that you are going to see an interactive screen like this:
 
 ![create-app-terminal](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746180/Allient/create-fastapi-project/demo-create-fastapi-final_fyirob.gif)
 
-## Getting Started
-
-The commands in this documentation can be customized on the **Makefile**. It can be started with and without docker.
-
-After your project is created. First, make sure you have all packages installed:
-
-```bash
-make install
-```
-
-Run the server:
-
-```bash
-# Run locally without docker
-make run-app
-# or
-# Run locally with docker in dev mode and force build
-make run-dev-build
-# or
-# Run locally with docker in dev mode
-make run-dev-build
-# or
-# Run locally with docker in prod mode
-make run-prod
-```
-
-## Learn More
-
-To learn more about Fastapi, take a look at the following resources:
-
-- [Fastapi Documentation](https://fastapi.tiangolo.com/).
-- [fastapi-alembic-sqlmodel-async](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async).
-- [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql).
-- [sqlmodel-tutorial](https://sqlmodel.tiangolo.com/tutorial/fastapi/).
-- [asyncer-tutorial](https://asyncer.tiangolo.com/tutorial/).
-- [fastapi-pagination](https://github.com/uriyyo/fastapi-pagination).
-- [fastapi-best-practices](https://github.com/zhanymkanov/fastapi-best-practices).
-- [awesome-fastapi](https://github.com/mjhea0/awesome-fastapi).
-
 ## Templates
 
 ### Basic
@@ -103,6 +64,22 @@ app
     └───test
 ```
 
+## ENV Variables
+
+```bash
+PROJECT_NAME=
+OPENAI_API_KEY=
+UNSPLASH_API_KEY= # Optional
+SERP_API_KEY= # Optional
+
+#############################################
+# Caddy variables
+#############################################
+EXT_ENDPOINT1=127.0.0.1
+LOCAL_1=localhost
+LOCAL_2=127.0.0.1
+```
+
 ## Tools
 
 - Search weather tool ![weather-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746086/Allient/create-fastapi-project/weather-tool-demo_lgqtwu.gif)
@@ -182,6 +159,45 @@ Developing web applications can be a challenging process, especially when dealin
 
 </details>
 
+## Getting Started
+
+The commands in this documentation can be customized on the **Makefile**. It can be started with and without docker.
+
+After your project is created. First, make sure you have all packages installed:
+
+```bash
+make install
+```
+
+Run the server:
+
+```bash
+# Run locally without docker
+make run-app
+# or
+# Run locally with docker in dev mode and force build
+make run-dev-build
+# or
+# Run locally with docker in dev mode
+make run-dev-build
+# or
+# Run locally with docker in prod mode
+make run-prod
+```
+
+## Learn More
+
+To learn more about Fastapi, take a look at the following resources:
+
+- [Fastapi Documentation](https://fastapi.tiangolo.com/).
+- [fastapi-alembic-sqlmodel-async](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async).
+- [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql).
+- [sqlmodel-tutorial](https://sqlmodel.tiangolo.com/tutorial/fastapi/).
+- [asyncer-tutorial](https://asyncer.tiangolo.com/tutorial/).
+- [fastapi-pagination](https://github.com/uriyyo/fastapi-pagination).
+- [fastapi-best-practices](https://github.com/zhanymkanov/fastapi-best-practices).
+- [awesome-fastapi](https://github.com/mjhea0/awesome-fastapi).
+
 ## Why use Create FastAPI Project?
 
 `create-fastapi-project` provides a streamlined way to kickstart your FastAPI projects. Here are some compelling reasons to choose it for your project setup:
diff --git a/create_fastapi_project/templates/langchain_basic/README.md b/create_fastapi_project/templates/langchain_basic/README.md
@@ -62,12 +62,10 @@ You can start editing the server by modifying `app/main.py`.
 
 ## Demo Langchain Tools
 
-This template includes some tools to help you get started with your project:
-
-- Search pokemon by name or id
-- Search weather by city name
-- Search images by keyword
-- Search videos by keyword
+- Search weather by city name ![weather-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746086/Allient/create-fastapi-project/weather-tool-demo_lgqtwu.gif)
+- Search images by keyword ![images-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746086/Allient/create-fastapi-project/search-images-demo_mkorzv.gif)
+- Search videos by keyword ![videos-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746087/Allient/create-fastapi-project/search-videos-demo_wikzn1.gif)
+- Search pokemon by name or id ![pokemon-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746086/Allient/create-fastapi-project/pokemon-tool-demo_ggsc63.gif)
 
 And also includes a agent that uses the tools to answer your questions.
 You can access the agent by opening [http://localhost:8000/chat](http://localhost:8000/chat) with your browser.
