NodeBB

(β˜… 15,200)

Node.js based forum software built for the modern web

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

  • .codeclimate.yml
  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .mocharc.yml
  • app.js
  • CHANGELOG.md
  • commitlint.config.js
  • dev.Dockerfile
  • docker-compose-pgsql.yml
  • docker-compose-redis.yml
  • docker-compose.yml
  • Dockerfile
  • eslint.config.mjs
  • Gruntfile.js
  • LICENSE
  • loader.js
  • nodebb
  • nodebb-global.js
  • nodebb.bat
  • README.md

πŸš€ Installation Guide

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

Downloads the entire project code from GitHub to your computer.

cd NodeBB

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.
> Requires Docker to be installed: https://docs.docker.com/get-docker/

Type this command into your terminal and run it.

βœ… 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.
cd install

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.
// repository documentation