Issues as newbie to NodeBB project

[purezen]

Hi, I am a newbie to the project. I faced a few issues while installing the nodeBB app and the docs app.

NodeBB app

• Installation doesn't mention instructions to install MongoDB, only redis. The part on installing mongdb comes in the configuring part while it is needed before running the setup script.
• In the via the cloud section in Installation, there is a none section and clicking on it opens a page with 404 - Not found message.

Docs

• Installation instructions are only for linux
• The source code has instructions for two MacOS versions it seems, but it shows only one - Maverick and Big Sur.
• The file structure has yarn.lock but not package-lock.json. While installing, git shows package-lock.json also. Should we include it or update gitignore?

Will be happy to open PR for these :)

[julianlam]

Hello, PRs are welcome. Please go ahead.

We do have windows installation instructions, but they are not official or tested: https://docs.nodebb.org/installing/os/windows/

The only recommended and supported installation environment is Ubuntu Linux

[purezen]

Sure, will do that!

I am working from a Mac, I can test out the Mac setup. And we can mention that only Ubuntu is supported officially? I did installation from the docs that are not shown in menu and it ran fine.. while the one in Menu was incomplete.

Also, Postgres is nowhere mentioned in the docs, but seems to be enabled in the codebase. What is the state of Postgres support ?

Regarding the frontend, is there a framework being used.. I could only find a plugin having angular in name ?

[julianlam]

Ubuntu is marked as recommended in the table of contents. Feel free to denote it elsewhere if you feel it necessary.

If the mac installation instructions are incomplete, please go ahead and fill in the missing information.

Postgres is supported but not documented as well as it was the most recently added database driver. MongoDB is still our recommended data store.

We do not use any frameworks like Angular, React, etc. We use jQuery, Benchpress, and our own bespoke implementations for other features.