NodeBB

mirror of https://github.com/NodeBB/NodeBB.git synced 2026-06-23 10:41:15 +02:00

Go to file

Julian Lam 0921230976 fix(style): updated code to follow new eslint recommendations

Squashed commit of the following:

commit f9ce878b26
Author: Julian Lam <julian@nodebb.org>
Date:   Tue Aug 13 14:30:46 2019 -0400

    fix(style): updated code to follow new eslint recommendations

commit 80dd370e41
Author: Julian Lam <julian@nodebb.org>
Date:   Tue Aug 13 14:14:58 2019 -0400

    fix(deps): update dependency sitemap to v4

    Squashed commit of the following:

    commit f4dd9cabb2
    Author: Julian Lam <julian@nodebb.org>
    Date:   Tue Aug 13 11:33:05 2019 -0400

        fix: resolved breaking changes from sitemap v4 upgrade

    commit 9043415ee1
    Merge: e3352b272 72590b346
    Author: Julian Lam <julian@nodebb.org>
    Date:   Tue Aug 13 11:09:55 2019 -0400

        Merge branch 'master' into renovate/sitemap-4.x

    commit e3352b272e
    Author: Renovate Bot <bot@renovateapp.com>
    Date:   Mon Aug 12 07:59:05 2019 +0000

        fix(deps): update dependency sitemap to v4

commit 8e3c0cdcae
Author: Renovate Bot <bot@renovateapp.com>
Date:   Fri Aug 9 00:49:51 2019 +0000

    fix(deps): update dependency commander to v3

commit 2104449d38
Author: Renovate Bot <bot@renovateapp.com>
Date:   Tue Aug 13 15:00:27 2019 +0000

    fix(deps): update dependency mongodb to v3.3.0

commit d2937f446a
Author: Barış Soner Uşaklı <barisusakli@gmail.com>
Date:   Tue Aug 13 10:36:48 2019 -0400

    feat: async/await admin/controllers

commit 1b97e8b199
Author: Misty (Bot) <deploy@nodebb.org>
Date:   Tue Aug 13 09:28:39 2019 +0000

    Latest translations and fallbacks

commit 69a48957a2
Author: Barış Soner Uşaklı <barisusakli@gmail.com>
Date:   Mon Aug 12 21:56:09 2019 -0400

    feat: async/await

commit b9b2a7e593
Author: Barış Soner Uşaklı <barisusakli@gmail.com>
Date:   Mon Aug 12 20:58:29 2019 -0400

    feat: async/await refactor

    controllers/accounts

commit a8d43a1759
Author: Baris Usakli <barisusakli@gmail.com>
Date:   Mon Aug 12 14:49:40 2019 -0400

    feat: async/await controllers/accounts

commit 2f25aae57b
Author: Barış Soner Uşaklı <barisusakli@gmail.com>
Date:   Sun Aug 11 23:09:50 2019 -0400

    fix: #7831, fix pagination

    convert to async/await

commit c9e83f2374
Author: Barış Soner Uşaklı <barisusakli@gmail.com>
Date:   Sun Aug 11 00:14:35 2019 -0400

    fix: remove empty line

commit 30be91b26c
Author: Barış Soner Uşaklı <barisusakli@gmail.com>
Date:   Sun Aug 11 00:13:41 2019 -0400

    fix: remove useless catchs and empty line

commit 2e4a71c0b6
Author: Renovate Bot <bot@renovateapp.com>
Date:   Sat Aug 10 06:51:50 2019 +0000

    chore(deps): update dependency eslint-config-airbnb-base to v14

2019-08-13 15:12:27 -04:00

.github

update issue template to show postgres version command

2018-09-15 17:31:48 -04:00

.tx

fix: added admin/manage/uploads to tx config

2018-11-27 15:14:56 -05:00

build

endpoint to download user attachments, #6441

2018-04-13 11:58:31 -04:00

install

fix(style): updated code to follow new eslint recommendations

2019-08-13 15:12:27 -04:00

logs

added daemon capability to ./nodebb start, npm start/stop scripts

2014-02-27 10:06:31 -05:00

public

fix(style): updated code to follow new eslint recommendations

2019-08-13 15:12:27 -04:00

src

fix(style): updated code to follow new eslint recommendations

2019-08-13 15:12:27 -04:00

test

Merge branch 'master' of https://github.com/NodeBB/NodeBB

2019-07-30 16:44:11 -04:00

.codeclimate.yml

tweak codeclimate settings

2018-10-21 19:45:17 -04:00

.editorconfig

Fix editorconfig syntax

2015-01-20 12:29:09 +01:00

.eslintignore

Support scoped theme packages

2018-06-11 10:10:16 -04:00

.eslintrc

fix(style): updated code to follow new eslint recommendations

2019-08-13 15:12:27 -04:00

.gitattributes

#3343

2015-07-21 11:17:31 -04:00

.gitignore

Add build/export to repo

2018-04-12 11:09:30 -04:00

.jsbeautifyrc

format/jshint favourites.js

2013-09-18 10:44:54 -04:00

.jshintrc

update esversion

2018-10-22 14:33:50 -04:00

.travis.yml

feat: add node12 to travis

2019-04-25 15:39:13 -04:00

app.js

chore(deps): update dependency eslint-config-airbnb-base to v13 (#6599 )

2018-11-07 15:53:14 -05:00

CHANGELOG.md

docs: updated changelog

2019-05-15 14:29:10 -04:00

commitlint.config.js

feat: enabling commitlint

2018-11-08 11:26:42 -05:00

Dockerfile

chore(deps): update node:8.16.0 docker digest to c671dc2

2019-07-23 16:48:55 -04:00

Gruntfile.js

Grunt active plugins (#7677 )

2019-06-11 12:50:40 -04:00

LICENSE

Resolving issue #2 -- added GPLv3 license file and updated package.json

2013-06-17 11:56:47 -04:00

loader.js

feat: Allow getting logfile path from config (#7044 )

2018-12-14 11:27:18 -05:00

nodebb

CLI refactor with commander (#6058 )

2017-11-23 10:55:03 -05:00

nodebb.bat

Fix #7263 (#7264 )

2019-01-18 00:41:20 -05:00

README.md

Update Node version

2019-04-10 13:36:57 -04:00

renovate.json

Add renovate.json

2018-06-18 14:44:21 -04:00

require-main.js

Enable require.main.require in tests (#6896 )

2018-10-31 09:58:37 -04:00

README.md

NodeBB Forum Software is powered by Node.js and built on either a Redis or MongoDB database. It utilizes web sockets for instant interactions and real-time notifications. NodeBB has many modern features out of the box such as social network integration and streaming discussions, while still making sure to be compatible with older browsers.

Additional functionality is enabled through the use of third-party plugins.

Screenshots

NodeBB's theming engine is highly flexible and does not restrict your design choices. Check out some themed installs in these screenshots below:

Our minimalist "Persona" theme gets you going right away, no coding experience required.

How can I follow along/contribute?

If you are a developer, feel free to check out the source and submit pull requests. We also have a wide array of plugins which would be a great starting point for learning the codebase.
If you are a designer, NodeBB needs themes! NodeBB's theming system allows extension of the base templates as well as styling via LESS or CSS. NodeBB's base theme utilizes Bootstrap 3 but themes can choose to use a different framework altogether.
If you know languages other than English you can help us translate NodeBB. We use Transifex for internationalization.
Please don't forget to like, follow, and star our repo! Join our growing community to keep up to date with the latest NodeBB development.

Requirements

NodeBB requires the following software to be installed:

A version of Node.js at least 8 or greater (installation/upgrade instructions)
Redis, version 2.8.9 or greater or MongoDB, version 2.6 or greater
nginx, version 1.3.13 or greater (only if intending to use nginx to proxy requests to a NodeBB)

Installation

Please refer to platform-specific installation documentation

Securing NodeBB

It is important to ensure that your NodeBB and database servers are secured. Bear these points in mind:

While some distributions set up Redis with a more restrictive configuration, Redis by default listens to all interfaces, which is especially dangerous when a server is open to the public. Some suggestions:
- Set bind_address to 127.0.0.1 so as to restrict access to the local machine only
- Use requirepass to secure Redis behind a password (preferably a long one)
- Familiarise yourself with Redis Security
Use iptables to secure your server from unintended open ports. In Ubuntu, ufw provides a friendlier interface to working with iptables.
- e.g. If your NodeBB is proxied, no ports should be open except 80 (and possibly 22, for SSH access)

Upgrading NodeBB

Detailed upgrade instructions are listed in Upgrading NodeBB

License

NodeBB is licensed under the GNU General Public License v3 (GPL-3) (http://www.gnu.org/copyleft/gpl.html).

Interested in a sublicense agreement for use of NodeBB in a non-free/restrictive environment? Contact us at sales@nodebb.org.

Languages

JavaScript 87.3%

Smarty 11.4%

SCSS 0.8%

Shell 0.2%

HTML 0.1%

Other 0.1%