Spaces:
Running
Running
MingruiZhang
commited on
doc: README (#108)
Browse files
README.md
CHANGED
@@ -8,74 +8,53 @@ pinned: false
|
|
8 |
app_port: 3000
|
9 |
---
|
10 |
|
11 |
-
<a href="https://
|
12 |
-
<img alt="
|
13 |
-
<h1 align="center">
|
14 |
</a>
|
15 |
|
16 |
<p align="center">
|
17 |
-
|
18 |
</p>
|
19 |
|
|
|
|
|
|
|
20 |
<p align="center">
|
21 |
-
|
22 |
-
|
23 |
-
|
24 |
-
|
25 |
-
|
26 |
</p>
|
27 |
<br/>
|
28 |
|
29 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
30 |
|
31 |
- [Next.js](https://nextjs.org) App Router
|
32 |
- React Server Components (RSCs), Suspense, and Server Actions
|
33 |
-
- [Vercel AI SDK](https://sdk.vercel.ai/docs) for streaming chat UI
|
34 |
-
- Support for OpenAI (default), Anthropic, Cohere, Hugging Face, or custom AI chat models and/or LangChain
|
35 |
- [shadcn/ui](https://ui.shadcn.com)
|
36 |
- Styling with [Tailwind CSS](https://tailwindcss.com)
|
37 |
- [Radix UI](https://radix-ui.com) for headless component primitives
|
38 |
- Icons from [Phosphor Icons](https://phosphoricons.com)
|
39 |
-
-
|
40 |
- [NextAuth.js](https://github.com/nextauthjs/next-auth) for authentication
|
41 |
|
42 |
-
## Model Providers
|
43 |
-
|
44 |
-
This template ships with OpenAI `gpt-3.5-turbo` as the default. However, thanks to the [Vercel AI SDK](https://sdk.vercel.ai/docs), you can switch LLM providers to [Anthropic](https://anthropic.com), [Cohere](https://cohere.com/), [Hugging Face](https://huggingface.co), or using [LangChain](https://js.langchain.com) with just a few lines of code.
|
45 |
-
|
46 |
-
## Deploy Your Own
|
47 |
-
|
48 |
-
You can deploy your own version of the Next.js AI Chatbot to Vercel with one click:
|
49 |
-
|
50 |
-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?demo-title=Next.js+Chat&demo-description=A+full-featured%2C+hackable+Next.js+AI+chatbot+built+by+Vercel+Labs&demo-url=https%3A%2F%2Fchat.vercel.ai%2F&demo-image=%2F%2Fimages.ctfassets.net%2Fe5382hct74si%2F4aVPvWuTmBvzM5cEdRdqeW%2F4234f9baf160f68ffb385a43c3527645%2FCleanShot_2023-06-16_at_17.09.21.png&project-name=Next.js+Chat&repository-name=nextjs-chat&repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-chatbot&from=templates&skippable-integrations=1&env=OPENAI_API_KEY%2CAUTH_GITHUB_ID%2CAUTH_GITHUB_SECRET%2CAUTH_SECRET&envDescription=How+to+get+these+env+vars&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-chatbot%2Fblob%2Fmain%2F.env.example&teamCreateStatus=hidden&stores=[{"type":"kv"}])
|
51 |
-
|
52 |
-
## Creating a KV Database Instance
|
53 |
-
|
54 |
-
Follow the steps outlined in the [quick start guide](https://vercel.com/docs/storage/vercel-kv/quickstart#create-a-kv-database) provided by Vercel. This guide will assist you in creating and configuring your KV database instance on Vercel, enabling your application to interact with it.
|
55 |
-
|
56 |
-
Remember to update your environment variables (`KV_URL`, `KV_REST_API_URL`, `KV_REST_API_TOKEN`, `KV_REST_API_READ_ONLY_TOKEN`) in the `.env` file with the appropriate credentials provided during the KV database setup.
|
57 |
-
|
58 |
## Running locally
|
59 |
|
60 |
-
You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js AI Chatbot. It's recommended you use [Vercel Environment Variables](https://vercel.com/docs/projects/environment-variables) for this, but a `.env` file is all that is necessary.
|
61 |
-
|
62 |
-
> Note: You should not commit your `.env` file or it will expose secrets that will allow others to control access to your various OpenAI and authentication provider accounts.
|
63 |
-
|
64 |
-
1. Install Vercel CLI: `npm i -g vercel`
|
65 |
-
2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link`
|
66 |
-
3. Download your environment variables: `vercel env pull`
|
67 |
-
|
68 |
```bash
|
69 |
pnpm install
|
70 |
pnpm dev
|
71 |
```
|
72 |
|
73 |
-
Your app
|
74 |
-
|
75 |
-
## Authors
|
76 |
-
|
77 |
-
This library is created by [Vercel](https://vercel.com) and [Next.js](https://nextjs.org) team members, with contributions from:
|
78 |
-
|
79 |
-
- Jared Palmer ([@jaredpalmer](https://twitter.com/jaredpalmer)) - [Vercel](https://vercel.com)
|
80 |
-
- Shu Ding ([@shuding\_](https://twitter.com/shuding_)) - [Vercel](https://vercel.com)
|
81 |
-
- shadcn ([@shadcn](https://twitter.com/shadcn)) - [Vercel](https://vercel.com)
|
|
|
8 |
app_port: 3000
|
9 |
---
|
10 |
|
11 |
+
<a href="https://va.landing.ai/">
|
12 |
+
<img alt="Vision Agent" src="https://va.landing.ai/landing4.png">
|
13 |
+
<h1 align="center">Vision Agent App</h1>
|
14 |
</a>
|
15 |
|
16 |
<p align="center">
|
17 |
+
Website app for Vision Agent
|
18 |
</p>
|
19 |
|
20 |
+
[production](https://va.landing.ai/)
|
21 |
+
[dev](https://va.landing.ai/)
|
22 |
+
|
23 |
<p align="center">
|
24 |
+
|
25 |
+
<a href="#Enviroments"><strong>Enviroments</strong></a> 路
|
26 |
+
<a href="#Frameworks"><strong>Frameworks</strong></a> 路
|
27 |
+
<a href="#running-locally"><strong>Running locally</strong></a> 路
|
28 |
+
|
29 |
</p>
|
30 |
<br/>
|
31 |
|
32 |
+
## Enviroments
|
33 |
+
|
34 |
+
| Enviroment | url | deployment | pipeline | release |
|
35 |
+
| -------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
36 |
+
| Production | [va.landing.ai](https://va.landing.ai/) | [aws-production](https://github.com/landing-ai/vision-agent-ui/deployments/aws-production) | [prod-deploy.yml](https://github.com/landing-ai/vision-agent-ui/actions/workflows/prod-deploy.yml) | release manually by [prod-deploy.yml](https://github.com/landing-ai/vision-agent-ui/actions/workflows/prod-deploy.yml) |
|
37 |
+
| Development | [va.dev.landing.ai](https://va.dev.landing.ai/) | [aws-development](https://github.com/landing-ai/vision-agent-ui/deployments/aws-development) | release when merge `main` | [cicd.yaml](https://github.com/landing-ai/vision-agent-ui/actions/workflows/cicd.yaml) |
|
38 |
+
| Vercel (Huggingface) | [huggingface.co](https://huggingface.co/spaces/LandingAI/vision-agent) | | release when merge `main` |
|
39 |
+
|
40 |
+
[cicd.yaml](https://github.com/landing-ai/vision-agent-ui/actions/workflows/cicd.yaml)
|
41 |
+
|
42 |
+
## Frameworks
|
43 |
|
44 |
- [Next.js](https://nextjs.org) App Router
|
45 |
- React Server Components (RSCs), Suspense, and Server Actions
|
|
|
|
|
46 |
- [shadcn/ui](https://ui.shadcn.com)
|
47 |
- Styling with [Tailwind CSS](https://tailwindcss.com)
|
48 |
- [Radix UI](https://radix-ui.com) for headless component primitives
|
49 |
- Icons from [Phosphor Icons](https://phosphoricons.com)
|
50 |
+
- ORM by [Prisma](https://www.prisma.io/)
|
51 |
- [NextAuth.js](https://github.com/nextauthjs/next-auth) for authentication
|
52 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
53 |
## Running locally
|
54 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
55 |
```bash
|
56 |
pnpm install
|
57 |
pnpm dev
|
58 |
```
|
59 |
|
60 |
+
Your app should now be running on [localhost:3000](http://localhost:3000/).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|