Skip to content

Commit c5b32c4

Browse files
committed
Merge branch 'langchain-template'
2 parents f00cee8 + 85c8644 commit c5b32c4

File tree

2 files changed

+59
-45
lines changed

2 files changed

+59
-45
lines changed

README.md

+55-39
Original file line numberDiff line numberDiff line change
@@ -13,45 +13,6 @@ After you that you are going to see an interactive screen like this:
1313

1414
![create-app-terminal](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746180/Allient/create-fastapi-project/demo-create-fastapi-final_fyirob.gif)
1515

16-
## Getting Started
17-
18-
The commands in this documentation can be customized on the **Makefile**. It can be started with and without docker.
19-
20-
After your project is created. First, make sure you have all packages installed:
21-
22-
```bash
23-
make install
24-
```
25-
26-
Run the server:
27-
28-
```bash
29-
# Run locally without docker
30-
make run-app
31-
# or
32-
# Run locally with docker in dev mode and force build
33-
make run-dev-build
34-
# or
35-
# Run locally with docker in dev mode
36-
make run-dev-build
37-
# or
38-
# Run locally with docker in prod mode
39-
make run-prod
40-
```
41-
42-
## Learn More
43-
44-
To learn more about Fastapi, take a look at the following resources:
45-
46-
- [Fastapi Documentation](https://fastapi.tiangolo.com/).
47-
- [fastapi-alembic-sqlmodel-async](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async).
48-
- [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql).
49-
- [sqlmodel-tutorial](https://sqlmodel.tiangolo.com/tutorial/fastapi/).
50-
- [asyncer-tutorial](https://asyncer.tiangolo.com/tutorial/).
51-
- [fastapi-pagination](https://github.com/uriyyo/fastapi-pagination).
52-
- [fastapi-best-practices](https://github.com/zhanymkanov/fastapi-best-practices).
53-
- [awesome-fastapi](https://github.com/mjhea0/awesome-fastapi).
54-
5516
## Templates
5617

5718
### Basic
@@ -103,6 +64,22 @@ app
10364
└───test
10465
```
10566

67+
## ENV Variables
68+
69+
```bash
70+
PROJECT_NAME=
71+
OPENAI_API_KEY=
72+
UNSPLASH_API_KEY= # Optional
73+
SERP_API_KEY= # Optional
74+
75+
#############################################
76+
# Caddy variables
77+
#############################################
78+
EXT_ENDPOINT1=127.0.0.1
79+
LOCAL_1=localhost
80+
LOCAL_2=127.0.0.1
81+
```
82+
10683
## Tools
10784

10885
- 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
182159

183160
</details>
184161

162+
## Getting Started
163+
164+
The commands in this documentation can be customized on the **Makefile**. It can be started with and without docker.
165+
166+
After your project is created. First, make sure you have all packages installed:
167+
168+
```bash
169+
make install
170+
```
171+
172+
Run the server:
173+
174+
```bash
175+
# Run locally without docker
176+
make run-app
177+
# or
178+
# Run locally with docker in dev mode and force build
179+
make run-dev-build
180+
# or
181+
# Run locally with docker in dev mode
182+
make run-dev-build
183+
# or
184+
# Run locally with docker in prod mode
185+
make run-prod
186+
```
187+
188+
## Learn More
189+
190+
To learn more about Fastapi, take a look at the following resources:
191+
192+
- [Fastapi Documentation](https://fastapi.tiangolo.com/).
193+
- [fastapi-alembic-sqlmodel-async](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async).
194+
- [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql).
195+
- [sqlmodel-tutorial](https://sqlmodel.tiangolo.com/tutorial/fastapi/).
196+
- [asyncer-tutorial](https://asyncer.tiangolo.com/tutorial/).
197+
- [fastapi-pagination](https://github.com/uriyyo/fastapi-pagination).
198+
- [fastapi-best-practices](https://github.com/zhanymkanov/fastapi-best-practices).
199+
- [awesome-fastapi](https://github.com/mjhea0/awesome-fastapi).
200+
185201
## Why use Create FastAPI Project?
186202

187203
`create-fastapi-project` provides a streamlined way to kickstart your FastAPI projects. Here are some compelling reasons to choose it for your project setup:

create_fastapi_project/templates/langchain_basic/README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,10 @@ You can start editing the server by modifying `app/main.py`.
6262

6363
## Demo Langchain Tools
6464

65-
This template includes some tools to help you get started with your project:
66-
67-
- Search pokemon by name or id
68-
- Search weather by city name
69-
- Search images by keyword
70-
- Search videos by keyword
65+
- Search weather by city name ![weather-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746086/Allient/create-fastapi-project/weather-tool-demo_lgqtwu.gif)
66+
- Search images by keyword ![images-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746086/Allient/create-fastapi-project/search-images-demo_mkorzv.gif)
67+
- Search videos by keyword ![videos-tool](https://res.cloudinary.com/dnv0qwkrk/image/upload/v1692746087/Allient/create-fastapi-project/search-videos-demo_wikzn1.gif)
68+
- 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)
7169

7270
And also includes a agent that uses the tools to answer your questions.
7371
You can access the agent by opening [http://localhost:8000/chat](http://localhost:8000/chat) with your browser.

0 commit comments

Comments
 (0)