https://github.com/mr-addict/punch-next

值班笔记 Next.js 重构
https://github.com/mr-addict/punch-next

mongodb nextjs tailwindcss typescript

Last synced: 6 days ago
JSON representation

值班笔记 Next.js 重构

• Host: GitHub
• URL: https://github.com/mr-addict/punch-next
• Owner: MR-Addict
• Created: 2023-04-27T08:04:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-23T15:18:20.000Z (26 days ago)
• Last Synced: 2024-10-24T22:45:50.775Z (25 days ago)
• Topics: mongodb, nextjs, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://punch.doiry.cn
• Size: 3.66 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 值班笔记

值班笔记 Next.js 重构。

|           首页           |         提交页面         |

| :----------------------: | :----------------------: |

| ![home](images/home.jpg) | ![form](images/form.jpg) |

本项目主要是个南京工业大学校大学生科协技术开发部使用的值班笔记，用来让大家记录值班期间所作的活动，同时做个值班备份，让后人可以来查看。

## 一、项目说明

### 1. 数据库

本项目使用`mongodb`作为数据库，只需要提供数据库的 URI 即可，新提交的值班笔记会存到`stas/notes`路径下。

### 2. 笔记归档

每学期结束后会把本学期的笔记添加到归档页面当中，归档页面不再使用数据库存储，而是使用本地的 JSON 文件，并编译成静态页面以提高访问速度。JSON 文件的路径是`archive` ，每条笔记的 schema 如下：

```json

{

  "_id": "string",

  "date": "string",

  "week": "number",

  "name": "string",

  "useMarkdown": "boolean",

  "content": "string"

}

```

使用下面的命令可以将当前数据库的笔记导出到 `archive` 目录下，导出前请确保以上环境变量已正确设置：

```bash

npm run archive

```

### 3. 值班时间

值班笔记可以设置值班时间，不在值班时间不能提交值班笔记，只能查看笔记。需要设置的时间有**第一周时间**，**开始时间**，**结束时间**和**当前学期**，第一周时间必须是每学期的第一天，否则页面有关学期周数的地方都会不准确，开始时间和第一周时间不一定要一样。

例如：

```conf

FIRST_WEEK="2024-09-02 00:01"

START_DATE="2024-09-02 00:01"

END_DATE="2025-01-19 23:59"

CURRENT_TERM="2024-2025年第一学期"

```

### 4. ~~ISR~~（已弃用）

ISR，也就是 Next.js 的按需编译，查看笔记的页面正常情况下都是静态页面，只有在新的提交笔记后才会重新编译，这样可以显著提高访问流畅度。

~~但是测试发现目前 13.3.2 版本本地使用存在问题，可是部署在 Vercel 之后又可以正常使用。这应该是 Bug，后面将持续关注随时更新 Next.js 的版本。另外目前 ISR 还没有嵌入到 app 目录当中，仍然在使用 pages 中的 api。~~（更新：13.4.0 之后的稳定版本推出后，现在使用 **revalidatePath** 就可以很简单地在服务端重新编译想要的静态页面，不需要另开 API 了。）

> 注：

>

> 自 2024年10月31日起，本项目已弃用 Next.js 的 ISR 功能

## 二、Docker 部署

本项目已经提前编译好了 Docker 镜像，部署只需要修改一些环境变量即可，如值班时间和当前学期名称，数据库URI不用改：

```yaml

services:

  punch:

    image: mraddict063/punch

    restart: unless-stopped

    ports:

      - 3000:3000

    environment:

      - FIRST_WEEK=2024-09-02 00:01

      - START_DATE=2024-09-02 00:01

      - END_DATE=2025-01-19 23:59

      - CURRENT_TERM=2024-2025年第一学期

      - MONGODB_URI=mongodb://punch:punch@mongodb:27017

    depends_on:

      - mongodb

  mongodb:

    image: mongo

    restart: unless-stopped

    environment:

      - MONGO_INITDB_ROOT_USERNAME=punch

      - MONGO_INITDB_ROOT_PASSWORD=punch

    volumes:

      - ./data:/data/db

```

## 三、原项目地址

原项目已不再维护，但是仍然可以使用：

- [https://github.com/MR-Addict/punch](https://github.com/MR-Addict/punch)