在浏览器中构建 Postgres 数据库——database.build 开源项目教程
1. 项目介绍
database.build 是一个在浏览器中运行的 Postgres 沙盒,带有 AI 辅助功能。它允许用户快速启动无限数量的 Postgres 数据库实例,并直接在浏览器中进行操作。每个数据库都与一个大型语言模型(LLM)配对,可以实现 CSV 文件拖放导入、报告生成、图表制作和数据库图表构建等有趣的使用场景。
2. 项目快速启动
以下是快速启动 database.build 的步骤:
首先,确保你已经安装了 Node.js。然后,克隆项目仓库到本地:
git clone https://github.com/supabase-community/database-build.git
cd database-build
安装项目依赖:
npm i
启动本地 Supabase 服务:
npx supabase start
在项目根目录下的 apps/web/.env.local
文件中存储 Supabase URL 和匿名密钥:
npx supabase status -o env \
--override-name api.url=NEXT_PUBLIC_SUPABASE_URL \
--override-name auth.anon_key=NEXT_PUBLIC_SUPABASE_ANON_KEY | grep NEXT_PUBLIC >> ./apps/web/.env.local
创建一个 OpenAI API 密钥,并将其保存到 apps/web/.env.local
文件中:
echo 'OPENAI_API_KEY="<openai-api-key>"' >> ./apps/web/.env.local
存储本地 KV(Redis)变量:
echo 'KV_REST_API_URL="http://localhost:8080"' >> ./apps/web/.env.local
echo 'KV_REST_API_TOKEN="local_token"' >> ./apps/web/.env.local
启动本地 Redis 容器:
docker compose -f ./apps/web/docker-compose.yml up -d
启动开发服务器:
npm run dev
现在,你应该能够在浏览器中访问并使用 database.build。
3. 应用案例和最佳实践
应用案例
- 数据分析和可视化:使用 database.build,你可以快速导入 CSV 数据,并在浏览器中进行分析和可视化。
- 原型设计和测试:在本地环境快速搭建数据库原型,进行应用程序的测试和开发。
最佳实践
- 持续集成:在项目开发过程中,使用 CI/CD 流程确保数据库构建的自动化和一致性。
- 版本控制:始终使用版本控制系统(如 Git)来管理数据库模式的变化。
4. 典型生态项目
database.build 是基于以下技术构建的:
- Next.js:用于构建主 Web 应用程序的前端框架。
- Postgres:强大的开源关系型数据库系统。
- PGlite:Postgres 的 WebAssembly 版本,允许在浏览器中运行 Postgres。
- Redis:用于缓存和速率限制的内存数据结构存储。
通过以上教程,你现在已经可以开始使用 database.build 来在浏览器中构建和操作 Postgres 数据库了。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考