(in progress)
Welcome! Please see the issues for items that need attention, and below for some tools to aid in development and debugging. We're working to interpolate chat functionality onto the map module.
Visit our roadmap for more information.
(https://draw.roadmap.sh/664d9e21d6b907c7f745be36)
Documentation:
https://chlorinated-birch-096.notion.site/MapGPT-Documentation-f7440889fca74582b31376192a30ed94
- App framework: Next.js
- Text streaming / Generative UI: Vercel AI SDK
- Generative Model: OpenAI
- Search API: Tavily AI / Exa AI
- Serverless Database: Upstash
- Component library: shadcn/ui
- Headless component primitives: Radix UI
- Styling: Tailwind CSS
cd mapgpt
bun install
Follow the guide below to set up Upstash Redis. Create a database and obtain UPSTASH_REDIS_REST_URL
and UPSTASH_REDIS_REST_TOKEN
. Refer to the Upstash guide for instructions on how to proceed.
cp .env.local.example .env.local
Your .env.local file should look like this:
# OpenAI API key retrieved here: https://platform.openai.com/api-keys
OPENAI_API_KEY=
# Tavily API Key retrieved here: https://app.tavily.com/home
TAVILY_API_KEY=
# Upstash Redis URL and Token retrieved here: https://console.upstash.com/redis
UPSTASH_REDIS_REST_URL=
UPSTASH_REDIS_REST_TOKEN=
#Mapbox access token NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
Note: This project focuses on Generative UI and requires complex output from LLMs. Currently, it's assumed that the official OpenAI models will be used. Although it's possible to set up other models, if you use an OpenAI-compatible model, but we don't guarantee that it'll work.
bun dev
You can now visit http://localhost:3000.
List of verified models that can be specified to writers.
- Groq
- LLaMA3 8b
- LLaMA3 70b
- Grok (coming soon)