WhyBuddy

(★ 364)

A Simple and Universal Product Rehearsal Engine, Speccing Anything. 简洁通用的产品推演引擎,推演万物。

Showing a partial file list — download the zip above to see everything.

  • .dockerignore
  • .env.example
  • .gitignore
  • .prettierignore
  • .prettierrc
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE
  • README.md
  • README.zh-CN.md
  • ROADMAP.md
  • SECURITY.md

🚀 Installation Guide

1. Get the code
git clone https://github.com/xiaojilele-glitch/WhyBuddy

Downloads the entire project code from GitHub to your computer.

cd WhyBuddy

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 --build

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

docker compose logs -f app python # follow logs

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

docker compose up -d --build # rebuild after pulling updates

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

docker compose down # stop (keeps data volumes)

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

docker compose down -v # stop and wipe data

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 run dev:all # full stack: frontend + server + executor

Starts the development/run server.

pnpm run dev:frontend # open http://localhost:3000

Starts the development/run server.

1. Fork & clone → pnpm install

Downloads and installs the libraries listed in package.json.

2. pnpm run dev:frontend (UI) or pnpm run dev:all (full stack)

Starts the development/run server.

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