WCF

(β˜… 248)

WoltLab Suite Core (previously WoltLab Community Framework)

Showing a partial file list β€” download the zip above to see everything.

  • .editorconfig
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
  • .php-cs-fixer.dist.php
  • .phpcs.xml
  • .prettierignore
  • .prettierrc
  • acpTemplateDelete.xml
  • composer.json
  • composer.lock
  • constants.php
  • eslint.config.mjs
  • fileDelete.xml
  • LICENSE
  • package-lock.json
  • package.json
  • phpstan-ambient.neon
  • phpstan-baseline.neon
  • phpstan.neon
  • README.md
  • syncTemplates.json
  • templateDelete.xml
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/WoltLab/WCF

Downloads the entire project code from GitHub to your computer.

cd WCF

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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f wcfsetup/install/files/js/3rdParty/codemirror/mode/dockerfile/dockerfile.js -t wcf .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 wcf

Runs the built image as an actual container.

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

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.
cd extra

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

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.

4. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
composer install

Installs the PHP libraries listed in composer.json.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.
// repository documentation