brycemclachlan/quiz-app-backend

LHL Node 项目骨架镜像

镜像概述

本镜像为LHL Node.js项目骨架，用于快速启动Node.js应用开发。它包含基础项目结构、PostgreSQL数据库配置示例、依赖管理及开发工具集成，帮助团队高效协作构建后端服务。

核心功能

• 提供标准化Node.js项目目录结构
• 集成PostgreSQL数据库配置与重置脚本
• 使用nodemon实现开发服务器自动重启
• 支持Sass编译为CSS（自动生成layout.css）
• 包含路由与数据库schema/seed分离示例

使用场景

• 团队协作开发Node.js后端应用的初始模板
• 快速搭建基于PostgreSQL的API服务原型
• 学习Node.js与数据库集成的实践项目

配置说明

团队协作设置

1. 使用模板创建公开仓库（建议以项目名命名）
2. 克隆仓库到本地并添加团队成员为协作者

本地开发步骤

1. 复制环境变量示例：cp .env.example .env
2. 更新.env文件：
   • username: labber
   • password: labber
   • database: midterm
3. 安装依赖：npm i
4. 重建sass二进制文件：npm rebuild node-sass
5. 重置数据库：npm run db:reset（重建表并插入种子数据）
6. 启动服务器：npm run local（访问http://localhost:8080）

警告与提示

• 勿直接编辑layout.css（由layout.scss自动生成）
• 按资源拆分路由文件（如users.js、widgets.js）
• 按表拆分数据库schema和seed文件
• 修改数据库结构/种子后需运行npm run db:reset（清除测试数据）

依赖

• Node 10.x及以上
• NPM 5.x及以上
• PG 6.x及以上

Docker部署示例

Docker Run命令

bash
docker run -d -p 8080:8080 \
  -v $(pwd)/.env:/app/.env \
  -v $(pwd)/db:/app/db \
  brycemclachlan/quiz-app-backend \
  npm run local

Docker Compose示例（docker-compose.yml）

yaml
version: '3'
services:
  backend:
    image: brycemclachlan/quiz-app-backend
    ports: ["8080:8080"]
    volumes:
      - ./.env:/app/.env
      - ./db:/app/db
    command: npm run local
    depends_on: [db]
  db:
    image: postgres:12
    environment:
      POSTGRES_USER: labber
      POSTGRES_PASSWORD: labber
      POSTGRES_DB: midterm
    volumes: [postgres_data:/var/lib/postgresql/data]

volumes: {postgres_data: {}}