alumnet

(★ 168)

AlumNet - AI-powered intelligent school history exhibition & alumni management system | AI 智能校史展示系统 — 校友星图

  • .gitignore
  • .lintstagedrc
  • AGENTS.md
  • CHANGELOG.md
  • code_of_conduct.md
  • commitlint.config.js
  • CONTRIBUTING.md
  • deploy.sh
  • DEPLOYMENT.md
  • docker-compose.dev.yml
  • docker-compose.yml
  • Dockerfile
  • ecosystem.config.js
  • ecosystem.production.js
  • eslint.config.mjs
  • HEARTBEAT.md
  • IDENTITY.md
  • LICENSE
  • nginx.conf
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • prettier.config.mjs
  • README.md
  • release_notes.md
  • SECURITY.md
  • server-coverage.txt
  • SOUL.md
  • test-full-output.txt
  • test-report-raw.txt
  • TOOLS.md
  • tsconfig.base.json
  • USER.md

# Installation Guide

1. Get the code
git clone https://github.com/jungang/alumnet

Downloads the entire project code from GitHub to your computer.

cd alumnet

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

├── docker-compose.yml # 🐳 Production Docker config

Runs the command against the services defined in the compose file.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm dev:server # Backend API → http://localhost:3000

Starts the development/run server.

pnpm dev:client # Kiosk frontend → http://localhost:5173

Starts the development/run server.

pnpm dev:admin # Admin dashboard → http://localhost:5174

Starts the development/run server.

pnpm build:server && pnpm build:client && pnpm build:admin

Type this command into your terminal and run it.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation