1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/nodebb_ynh.git synced 2024-09-03 19:46:29 +02:00
nodebb_ynh/README.md
2024-04-14 16:18:41 +00:00

50 lines
2 KiB
Markdown

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->
# NodeBB for YunoHost
[![Integration level](https://dash.yunohost.org/integration/nodebb.svg)](https://dash.yunohost.org/appci/app/nodebb) ![Working status](https://ci-apps.yunohost.org/ci/badges/nodebb.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/nodebb.maintain.svg)
[![Install NodeBB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodebb)
*[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install NodeBB quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
NodeBB is built using the Node.js server-side Javascript platform, delivering unmatched performance.
Building on this high performance platform means fast and dependable performance that will support even the biggest and most active community.
**Shipped version:** 3.7.3~ynh1
**Demo:** <https://try.nodebb.org>
## Screenshots
![Screenshot of NodeBB](./doc/screenshots/screenshot.png)
## Documentation and resources
- Official app website: <https://nodebb.org>
- Official admin documentation: <https://docs.nodebb.org>
- Upstream app code repository: <https://github.com/NodeBB/NodeBB>
- YunoHost Store: <https://apps.yunohost.org/app/nodebb>
- Report a bug: <https://github.com/YunoHost-Apps/nodebb_ynh/issues>
## Developer info
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing --debug
or
sudo yunohost app upgrade nodebb -u https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>