# Components Library
This library Components that can be installed onto any Raptor site.


### Format
The library follow a format that each component must follow
* `template.php` (required) - The template file
* `style.scss` (required) - The styling for the component

### Naming Convention
A component should follow the format `<component-name>-<number>`.

Example:
* `header-01`
* `header-02`
* `footer-01`

### Current compatable components
The library currently supports the following component types:
* `header-<number>`
* `footer-<number>`

Additional component types will be introduced in future updates as the library expands.

## Previews
Previews are to be made for all components. To add a preview take a screenshot of the design and place in the previews directory at the root. (If the previews directory doesn't exit create one)

### Naming Convention
To match the Component name as a jpeg: `<component-name>-<number>.jpeg`

Example:
* `header-01.jpeg`
* `footer-01.jpeg`

### Pushing previews to server
You will need to have the .env file in the root with the required environment variables of which can be found on Clickup. 

Run this command to deploy the previews to the server.

* `npm run deploy-previews`