Skip to content

README.md

Latest commit

 

History

History
176 lines (121 loc) · 4.77 KB

README.md

File metadata and controls

176 lines (121 loc) · 4.77 KB

App Website

Public monorepo for the RWKV app download website and its supporting backend API.

License: MIT README: English README: 简体中文

Quick Commands

# local development
pnpm dev

# production deployment
pnpm deploy:prod

Documentation

Repository Layout

app_website/
├── backend/          # NestJS backend API and admin endpoints
├── frontend/         # Next.js frontend
├── tools/            # maintenance scripts
└── package.json      # workspace scripts

Tech Stack

Backend

  • NestJS
  • Prisma
  • TypeScript
  • SQLite

Frontend

  • Next.js
  • React
  • Jotai
  • TypeScript

Production Topology

The current production architecture is:

  • the frontend is built as a static export into frontend/out
  • nginx serves the static frontend
  • the backend runs separately under PM2
  • nginx proxies API traffic to the backend, which listens on port 3462 by default

For the current nginx + PM2 setup, frontend/out is the canonical frontend build output.

Prerequisites

  • Node.js >= 18
  • pnpm >= 8

Installation

pnpm install
cp backend/.env.example backend/.env.local
cp frontend/.env.local.example frontend/.env.local

Then edit the copied files and replace placeholder values with your local configuration.

For local development, prefer backend/.env.local and frontend/.env.local. If backend/.env also exists, .env.local should contain your local overrides such as the local backend port.

Development

Recommended local development defaults:

  • frontend: http://localhost:3010
  • backend: http://localhost:3001
pnpm dev

Notes:

  • pnpm dev starts both frontend and backend together
  • the browser talks only to http://localhost:3010
  • the Next.js dev server rewrites API requests to the backend origin configured in frontend/.env.local
  • this avoids browser-side cross-origin requests during local development
  • if you need to run the services separately, use pnpm --filter backend dev or pnpm --filter frontend dev

Build

pnpm build

This builds the frontend static export into frontend/out and also builds the backend application.

Production Deployment Notes

Typical production responsibilities are split as follows:

  • frontend: build frontend/out and let nginx serve it directly
  • backend: build the NestJS app and run it with PM2

The canonical one-command production publish command is:

pnpm deploy:prod

This command is intended to run on the production server. It:

  • builds the frontend into frontend/out
  • keeps frontend/out as the live static directory for nginx
  • prepares Prisma
  • builds the backend
  • restarts or starts rwkv-backend under PM2

Each frontend build also writes deployment metadata into frontend/public/build-info.json, which is exported as /build-info.json in the final site. This is used as a build marker so you can verify which frontend build is currently online.

You can check it with:

curl
https://rwkv.halowang.cloud/build-info.json

You can also inspect the page source or DevTools and look for these meta tags:

  • rwkv-build-summary
  • rwkv-build-time
  • rwkv-build-source
  • rwkv-build-commit-short

For production, prefer real environment variables or a server-local backend/.env or backend/.env.local file on the host. Do not commit production secrets.

Environment Variables

The repository is public, so no real secrets are committed here.

Best practice in this repository:

  • commit example files such as backend/.env.example and frontend/.env.local.example
  • do not commit real .env, .env.local, .env.development.local, or production secret files
  • do not introduce a custom .develop file name; use the standard .env.local / .env.development conventions instead

Use backend/.env.example and frontend/.env.local.example as templates and provide real values only in your local or deployment environment.

Common variables:

  • HOST
  • PORT
  • ADMIN_USERNAME
  • ADMIN_PASSWORD
  • ADMIN_TOKEN_SECRET
  • ADMIN_TOKEN_TTL_HOURS
  • HF_DATASETS_ID
  • HF_TOKEN
  • HF_ENDPOINT
  • GITHUB_REPO
  • GITHUB_TOKEN
  • GITHUB_WEBHOOK_SECRET
  • PGYER_API_KEY
  • PGYER_APP_KEY
  • BACKEND_ORIGIN

Public Project Note

Please do not commit real credentials, tokens, private server-specific secrets, or private environment files to this repository.