From db463807d75c043c42865cdec7f1cbc35b6b87ad Mon Sep 17 00:00:00 2001 From: Eric Huang Date: Fri, 17 Nov 2023 21:22:34 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E4=BA=86=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env | 3 ++- README.md | 25 +++++++++++++++++-------- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/.env b/.env index 2e4c197..0026c71 100644 --- a/.env +++ b/.env @@ -1,6 +1,7 @@ # JWT secret SECRET="mysecret123" -WEB_PUSH_CONTACT="mailto:erich2s@qq.com" +WEB_PUSH_CONTACT="mailto:example@gmail.com" # 打包到前端的环境变量要加上NEXT_PUBLIC_前缀 +# VAPID_KEY NEXT_PUBLIC_VAPID_KEY="BDeQByhHcxy084_JFou3rHlqiSpFvPZhUWjQKb1QlU6TjXL8mJd3usKDsQDzEeZ1HJOuultQgtPRlGOqgrrLnQA" PRIVATE_VAPID_KEY="rZpj98WVatLMqzgWkC_mQgAbzG3WAZAtiw9hiMW3taY" diff --git a/README.md b/README.md index b10697a..b471ee2 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ ## 📝 简介 -本项目是一个基于`TypeScript + Nextjs 13(App Router)` 开发的后勤报修管理系统，由管理员端（Web端）和用户端（以PWA形式的移动设备）组成，管理员端可对用户、维修单、维修工人进行管理，用户端可进行报修单的提交、查看等功能；通过Web Worker技术，实现了两端只要开启通知权限，都可以接收到维修单状态的最新动态推送通知。 +本项目是一个基于`TypeScript + Next.js 14 (App Router)` 开发的后勤报修管理系统，由管理员端（Web端）和用户端（以PWA形式的移动设备）组成，管理员端可对用户、维修单、维修工人进行管理，用户端可进行报修单的提交、查看等功能；通过Web Worker技术，实现了两端只要开启通知权限，都可以接收到维修单状态的最新动态推送通知。 ![screenshot](./screenshot.jpg) ## 🚀 技术栈 -- `Nextjs 13(App Router)` +- `Next.js 14 (App Router)` - `Tailwindcss` - `shadcn/ui` - `高德地图SDK` @@ -39,14 +39,23 @@ ## 🛠️ 本地开发 -首先 `git clone` 本仓库，然后进入项目目录，执行以下命令： +1. 首先 `git clone` 本仓库，然后进入项目目录，执行以下命令： -```bash -pnpm install -pnpm dev -``` + ```bash + pnpm install + pnpm dev + ``` + +2. 将项目根目录下的`.env.`和`.env.development`中的环境变量配置好，尤其是`.env.development`中的`DATABASE_URL`(即你的数据库url)，并启动好数据库。 + +3. 初始化并seeding数据库(将一些模拟数据和管理员账号写进数据库)： + + ```bash + pnpm add -g dotenv-cli + pnpm run resetDB:dev + ``` -之后在浏览器打开 [http://localhost:3000](http://localhost:3000) 即可。 +4. 之后在浏览器打开 [http://localhost:3000](http://localhost:3000) 即可。 ## 📦 部署