hackrva/memberserver

Member Dashboard

概述

Member Dashboard是创客空间成员访问权限的权威管理系统。系统每日从支付提供商拉取会员状态，若成员在过去30天内有付款记录，则被认定为活跃成员，以此为基础管理成员访问权限。

核心功能与特性

• 会员状态管理：从***拉取支付信息并存储到数据库，识别当前活跃成员
• 访问列表维护：维护成员访问列表并定期推送到网络中的微控制器
• 网络独立访问：微控制器（资源）本地存储访问列表，确保成员访问时不依赖网络连接

使用场景

适用于创客空间等需要精细化管理成员访问权限的场所，特别适合对网络稳定性要求较高、需要确保离线状态下仍能正常进行访问控制的场景。

开发设置

简单方式（使用Remote-Containers）

前置要求

安装以下工具：

• Docker
• VS Code
• VS Code Remote-Containers 扩展

操作步骤

1. 无需额外安装其他工具。Windows用户建议将仓库克隆到WSL文件夹中以获得最佳性能。
2. 在VS Code中打开文件夹，选择"在容器中重新打开"，或运行"Remote-Containers: Open Folder in Container..."命令并选择本地文件夹。

!从容器打开

3. 启动后端服务器：

   • 通过VS Code调试启动
   • 或不调试启动：sh buildandrun.sh

4. 启动Web应用（参考UI README）：

   bash
   # 导航到ui文件夹
   cd ui
   
   # 安装node模块
   npm ci
   
   # 运行本地环境
   npm run dev
   

5. 连接容器终端：若VS Code终端窗格空间不足，可通过以下命令从终端连接开发容器：

   bash
   docker exec -it -u vscode memberdashboard_dev_1 bash
   

不那么简单的方式

前置依赖

至少安装以下工具：

• docker
• docker-compose
• go
• node
• https://github.com/golang-migrate/migrate/tree/master/cmd/migrate

环境准备

1. 参考ui目录下的README安装npm模块
2. 单独安装rollup：

   bash
   npm install --global rollup
   

启动应用

本项目使用Docker，可通过构建脚本启动测试环境：

bash
sh buildandrun.sh

数据库初始化（测试数据）

创建会员数据库并授予用户"test"权限：

bash
cd test/postgres
sh seedLocal.sh

安装golang-migrate

bash
go install github.com/golang-migrate/migrate/v4/cmd/migrate

配置文件

应用需要配置文件，路径通过MEMBER_SERVER_CONFIG_FILE环境变量设置。可使用sample.config.json作为模板：

bash
export MEMBER_SERVER_CONFIG_FILE="/etc/hackrva/config.json"

开发任务

数据库迁移

数据库迁移使用https://github.com/golang-migrate/migrate%E7%AE%A1%E7%90%86%E3%80%82Remote-Containers%E7%8E%AF%E5%A2%83%E5%B7%B2%E5%86%85%E7%BD%AECLI%EF%BC%8C%E5%85%B6%E4%BB%96%E7%8E%AF%E5%A2%83%E9%9C%80%E6%89%8B%E5%8A%A8%E5%AE%89%E8%A3%85%E3%80%82

添加迁移

在migrations文件夹中创建升级和降级迁移文件，命名格式为{序号}_{描述}.up.sql和{序号}_{描述}.down.sql。可通过以下命令创建：

bash
make migration name=<名称>

填充升级和降级脚本：升级脚本需保证幂等性，降级脚本需回滚升级脚本的所有更改。

运行迁移

通过CLI应用迁移：

bash
make migrate-up

生成Swagger文档

Remote-Containers环境中可直接更新Swagger文档：

bash
make swagger

其他环境需先参考./docs/README.md安装swagger。

查询Postgres

Remote-Containers环境中可通过以下方式查询Postgres：

• 使用VS Code的PostgreSQL扩展
• 通过localhost:8080访问pgAdmin，账号：***，密码：test
• 使用make run-sql或make run-sql-command命令