1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/nocodb_ynh.git synced 2024-09-03 19:56:01 +02:00
nocodb_ynh/README.md

64 lines
2.5 KiB
Markdown
Raw Normal View History

2021-05-28 08:44:53 +02:00
<!--
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.
-->
2021-09-27 19:59:13 +02:00
# NocoDB for YunoHost
2021-05-28 08:44:53 +02:00
2022-06-15 20:48:21 +02:00
[![Integration level](https://dash.yunohost.org/integration/nocodb.svg)](https://dash.yunohost.org/appci/app/nocodb) ![Working status](https://ci-apps.yunohost.org/ci/badges/nocodb.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/nocodb.maintain.svg)
2021-09-27 19:59:13 +02:00
[![Install NocoDB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nocodb)
2021-05-28 08:44:53 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-09-27 19:59:13 +02:00
> *This package allows you to install NocoDB quickly and simply on a YunoHost server.
2021-05-28 08:44:53 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2021-09-27 20:19:15 +02:00
NocoDB is an open source NoCode platform that turns any database into a smart spreadsheet, alternative to Airtable.
* Connect to new/existing SQL database and turn them into spreadsheet.
* Create grid view, gallery view, kanban view and calendar view on top your data
* Search, sort, filter columns and rows with ultra ease
* Invite your team with fine grained Access Control
* Share views publicly and also with password protection
* Provides REST & GraphQL APIs with Swagger & GraphiQL GUI
*(from NocoDB's website)*
2021-05-28 08:44:53 +02:00
2022-06-29 08:07:13 +02:00
**Shipped version:** 0.92.0~ynh1
2021-05-28 08:44:53 +02:00
2021-09-27 19:59:13 +02:00
**Demo:** https://www.nocodb.com/demos
2021-05-28 08:44:53 +02:00
## Screenshots
2022-06-15 20:48:21 +02:00
![Screenshot of NocoDB](./doc/screenshots/example.png)
2021-05-28 08:44:53 +02:00
## Disclaimers / important information
2021-09-27 20:19:15 +02:00
NocoDB has its own authentication system which does not rely on YunoHost's SSO or LDAP server.
* You can make it public, especially if you need its API.
* You will need to create the first admin right after installation.
2021-05-28 08:44:53 +02:00
## Documentation and resources
2022-06-21 03:15:48 +02:00
* Official app website: <https://www.nocodb.com>
2022-06-15 20:48:21 +02:00
* Upstream app code repository: <https://github.com/nocodb/nocodb>
* YunoHost documentation for this app: <https://yunohost.org/app_nocodb>
* Report a bug: <https://github.com/YunoHost-Apps/nocodb_ynh/issues>
2021-05-28 08:44:53 +02:00
## Developer info
2021-09-27 19:59:13 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nocodb_ynh/tree/testing).
2021-05-28 08:44:53 +02:00
To try the testing branch, please proceed like that.
2022-06-15 20:48:21 +02:00
``` bash
2021-09-27 19:59:13 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/nocodb_ynh/tree/testing --debug
2021-05-28 08:44:53 +02:00
or
2021-09-27 19:59:13 +02:00
sudo yunohost app upgrade nocodb -u https://github.com/YunoHost-Apps/nocodb_ynh/tree/testing --debug
2021-05-28 08:44:53 +02:00
```
2022-06-15 20:48:21 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>