快速上手

写在前面

文档书写基于1.8.2版本,如果后面模板升级发现有对不上的,以官方文档为准

前置要求

为确保你能顺利使用 ShipAny 开发项目, 请先点击完成前置要求

初始化项目

点击查看如何克隆项目到本地

克隆完毕后,

安装依赖

pnpm install

启动开发服务器

pnpm dev

在浏览器打开网页:http://localhost:3000 ,即可预览项目

修改网站配色

shadcn 主题调试器

访问 https://tweakcn.com/editor/theme,为你的项目挑一款主题配色。

当前模板使用 tailwindcss4,请使用 oklch 颜色格式,复制主题样式

图片

图片

粘贴主题样式到项目文件:src/config/style/theme.css

图片

配置环境变量

cp .env.example .env.development

修改NEXT_PUBLIC_APP_NAME

NEXT_PUBLIC_APP_NAME 改成你的项目名称

修改DATABASE_URL

使用Supabase数据库

访问 https://supabase.com/ 登录后,新建项目

图片

图片

创建成功后,

图片

图片

点击下图中的”复制“icon
图片

回到IDE编辑器,打开.env.development 更新DATABASE_URL

注意:[YOUR-PASSWORD] 是你要替换的内容,[]也要删除了,要不然连不上

修改AUTH_SECRET

终端执行下面命令生成1段值

openssl rand -base64 32

例如: R6egZTFAaiKY7SMDRtXspXwyVo9UPtxf4yn0w1pLs6w2
将其更新到 AUTH_SECRET

数据库初始化

先后执行

pnpm db:generate
pnpm db:migrate

RBAC初始化

pnpm rbac:init

注册账号

访问 http://localhost:3000/sign-up

先注册一个账户,例如: root@admin.com

注册成功后,分配超级管理员权限,终端执行

pnpm rbac:assign -- --email=root@admin.com --role=super_admin

执行成功后,访问 http://localhost:3000/admin,即可进入管理后台。

图片

登录

Google登录

Google登录官方文档

Github登录

Github登录官方文档

配置图片存储R2

R2官方文档

支付

Stripe支付

Stripe支付官方文档

Creem支付

Creem支付官方文档

Paypal支付

Paypal支付官方文档

导入导航预制数据(选做)

导航模板如果没有数据支撑,就显得很空,这时候就需要你先在后台/admin/nav-items路由下维护一些知名导航进去(或者爬虫爬取一些);

如果说你不想那么费劲,可以导入下我预制的导航数据,也就是你在https://navs.995010.xyz/上看到的数据。

打开shipany-template-navigation/db/navigation.sql
复制所有内容,打开supabase下的SQL Editor

图片

粘贴进去再执行Run即可

图片

成功后回到项目http://localhost:3000/ 就可以看到数据了

图片

后续管理在http://localhost:3000/admin/nav-items

部署

部署到 Vercel

部署到Vercel官方文档

部署到Cloudflare

部署到Cloudflare官方文档

部署到Dokploy

部署到Dokploy官方文档