Vulcan Next 开源项目教程
1、项目介绍
Vulcan Next 是一个基于 Next.js 和 GraphQL 的生产级应用启动器。它旨在帮助开发者快速构建基于 GraphQL 的应用程序,特别适用于 B2B SaaS 软件、CMS 平台以及依赖大量 CRUD 操作的应用。Vulcan Next 提供了以下核心功能:
- Next.js + Apollo GraphQL 样板代码:提供了一个生产级的 Next.js 和 Apollo GraphQL 样板代码,帮助开发者快速启动项目。
- GraphQL API 端点:集成了 Apollo Server 和 Mongo 连接器,开发者可以立即开始编写后端功能。
- 开发工具:包括 Cypress、Jest、Storybook 等开发工具,提升开发效率。
- 基于模式的辅助工具和钩子:帮助开发者快速生成和消费自己的 GraphQL API。
2、项目快速启动
安装和运行
-
克隆项目:
git clone -b main https://github.com/VulcanJS/vulcan-next cd vulcan-next
-
安装依赖:
yarn
-
启动开发服务器:
yarn run dev
-
访问应用: 打开浏览器,访问
http://localhost:3000
。
配置本地数据库
-
运行 Mongo 服务器:
yarn run start:mongo
-
配置应用使用本地数据库: 在
.env.development
或.env.development.local
文件中,设置以下 URI:MONGO_URI="mongodb://localhost:27017/vulcan-next-app"
-
重启应用: 停止服务器并重新启动。
3、应用案例和最佳实践
应用案例
- Devographics 调查:Vulcan Next 为 State of JS、State of CSS 和 State of GraphQL 等调查提供了支持。
- B2B SaaS 软件:适用于构建企业级 SaaS 软件,特别是那些依赖大量数据管理和 API 消费的应用。
最佳实践
- 使用 Docker 运行数据库:建议使用 Docker 运行本地 Mongo 数据库,以确保开发环境的一致性。
- 定期更新 Vulcan Next:由于 Vulcan Next 是一个样板代码,建议定期检查并手动更新到最新版本,以确保应用的稳定性和安全性。
4、典型生态项目
- Next.js:Vulcan Next 基于 Next.js 构建,Next.js 是一个流行的 React 框架,支持服务器端渲染和静态站点生成。
- Apollo GraphQL:Vulcan Next 使用 Apollo GraphQL 作为其 GraphQL 客户端和服务器实现,提供强大的 GraphQL 功能。
- MongoDB:Vulcan Next 默认使用 MongoDB 作为其数据库,提供灵活的数据存储和查询功能。
- Cypress:用于端到端测试,确保应用在不同环境下的稳定性和一致性。
- Jest:用于单元测试,帮助开发者快速发现和修复代码中的问题。
- Storybook:用于组件开发和文档,提升组件的可重用性和可维护性。