Name	Last modified	Size	Description
	Parent Directory		-
	admin/	2023-06-15 18:18	-
	docs/	2023-06-15 18:18	-
	server/	2023-06-15 18:18	-
	strapi-server.js	2022-03-17 08:47	53
	strapi-admin.js	2022-03-17 08:47	64
	README.md	2022-04-11 15:50	1.2K	d7c1522 post receive test [كارل مبارك]
	LICENSE	2022-04-11 16:05	1.2K
	package.json	2023-06-15 18:21	2.1K

# Strapi plugin Awesome Help

*This plugin is not intended to be used in production.*
*This is a learning aid. Nevertheless, we will try to go as far as possible in its design and deployment.*

This plugin includes all code you need to follow this technical articles: 
[A Strapi plugin from scratch to production](https://medium.com/p/a6deeaf553de)

- [DESCRIPTION](#description)
- [FEATURES](#features)
- [INSTALLATION](#installation)
- [CONFIGURATION](#configuration)


## DESCRIPTION  
The purpose of this plugin is to display an icon on each form label present in each document to display contextual help. 
When the user over the icon, the plugin displays a tooltip with a helpful text.

![Awesome Help in document](./docs/document.png)

![Awesome Help main UI](./docs/MainUI.png)

## FEATURES  
* Add contextual Help on your Strapi documents.
* Scan the Strapi Structure to get all textual and numerical fields.

## INSTALLATION  

```bash
#npm
npm install @exfabrica/strapi-plugin-awesome-help
```
```bash
#yarn
yarn add @exfabrica/strapi-plugin-awesome-help
```
## CONFIGURATION  
Just go inside the general settings of Awesome Help to enable / disable the contextual help.

![Awesome Help](./docs/settings.png)