1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/elabftw_ynh.git synced 2024-09-03 18:26:23 +02:00
elabftw_ynh/README.md

52 lines
2.4 KiB
Markdown
Raw Normal View History

2021-08-12 13:28:59 +02:00
<!--
2024-03-29 07:01:10 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2021-08-12 13:28:59 +02:00
It shall NOT be edited by hand.
-->
2021-08-12 13:28:44 +02:00
# eLabFTW for YunoHost
2023-08-15 11:55:00 +02:00
[![Integration level](https://dash.yunohost.org/integration/elabftw.svg)](https://dash.yunohost.org/appci/app/elabftw) ![Working status](https://ci-apps.yunohost.org/ci/badges/elabftw.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/elabftw.maintain.svg)
2021-08-12 13:28:59 +02:00
[![Install eLabFTW with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=elabftw)
2024-05-28 23:41:45 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2021-08-12 13:28:44 +02:00
2024-03-29 07:01:10 +01:00
> *This package allows you to install eLabFTW 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.*
2021-08-12 13:28:44 +02:00
## Overview
2022-05-17 11:38:56 +02:00
eLabFTW is an electronic lab notebook manager for research teams.
It lets you store and organize your research experiments easily. It also features a database where any kind of objects (such as antibodies, plasmids, cell lines, boxes, etc.) can be stored. It is accessed via the browser. Several research teams can be hosted on the same installation. This means eLabFTW can be installed at the institute level and host all team members at the same place. This is what is done at Institut Curie and in several other research centers around the globe.
2021-08-12 13:28:44 +02:00
2024-03-03 17:11:37 +01:00
**Shipped version:** 4.2.4~ynh4
2022-08-15 19:01:29 +02:00
2024-03-29 07:01:10 +01:00
**Demo:** <https://demo.elabftw.net/login.php>
2021-08-12 13:28:44 +02:00
2021-08-12 13:28:59 +02:00
## Screenshots
2021-08-12 13:28:44 +02:00
2022-08-15 19:01:29 +02:00
![Screenshot of eLabFTW](./doc/screenshots/screen-1.jpg)
2021-08-12 13:28:44 +02:00
2021-08-12 13:28:59 +02:00
## Documentation and resources
2021-08-12 13:28:44 +02:00
2024-03-29 07:01:10 +01:00
- Official app website: <https://www.elabftw.net>
- Official admin documentation: <https://doc.elabftw.net/>
- Upstream app code repository: <https://github.com/elabftw/elabftw>
- YunoHost Store: <https://apps.yunohost.org/app/elabftw>
- Report a bug: <https://github.com/YunoHost-Apps/elabftw_ynh/issues>
2021-08-12 13:28:44 +02:00
## Developer info
2024-03-29 07:01:10 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/elabftw_ynh/tree/testing).
2021-08-12 13:28:44 +02:00
2024-03-29 07:01:10 +01:00
To try the `testing` branch, please proceed like that:
2022-08-15 19:01:29 +02:00
2024-03-29 07:01:10 +01:00
```bash
2021-08-12 13:28:59 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/elabftw_ynh/tree/testing --debug
2021-08-12 13:28:44 +02:00
or
2021-08-12 13:28:59 +02:00
sudo yunohost app upgrade elabftw -u https://github.com/YunoHost-Apps/elabftw_ynh/tree/testing --debug
2021-08-12 13:28:44 +02:00
```
2021-08-12 13:28:59 +02:00
2024-03-29 07:01:10 +01:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>