mirror of
https://github.com/YunoHost-Apps/fluffychat_ynh.git
synced 2024-09-03 18:36:04 +02:00
2.6 KiB
2.6 KiB
Packaging an app, starting from this example
- Copy this app before working on it, using the 'Use this template' button on the Github repo.
- Edit the
manifest.json
with app specific info. - Edit the
install
,upgrade
,remove
,backup
, andrestore
scripts, and any relevant conf files inconf/
.- Using the script helpers documentation.
- Add a
LICENSE
file for the package. - Edit
doc/DISCLAIMER*.md
- The
README.md
files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
Example app for YunoHost
This package allows you to install Example app quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.
Overview
This is a dummy description of this app features
Shipped version: 1.0~ynh1
Demo: https://demo.example.com
Screenshots
Documentation and resources
- Official app website: https://example.com
- Official user documentation: https://yunohost.org/apps
- Official admin documentation: https://yunohost.org/packaging_apps
- Upstream app code repository: https://some.forge.com/example/example
- YunoHost Store: https://apps.yunohost.org/app/example
- Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
Developer info
Please send your pull request to the testing branch.
To try the testing branch, please proceed like that.
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
More info regarding app packaging: https://yunohost.org/packaging_apps