https://github.com/codeclutch-dev/oc-contact-plugin
Plugin providing contact information on website for October CMS
https://github.com/codeclutch-dev/oc-contact-plugin
laravel octobercms octobercms-plugin php
Last synced: 5 months ago
JSON representation
Plugin providing contact information on website for October CMS
- Host: GitHub
- URL: https://github.com/codeclutch-dev/oc-contact-plugin
- Owner: codeclutch-dev
- License: mit
- Created: 2021-07-15T21:28:26.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-15T22:45:26.000Z (almost 5 years ago)
- Last Synced: 2024-05-02T07:06:53.405Z (about 2 years ago)
- Topics: laravel, octobercms, octobercms-plugin, php
- Language: PHP
- Homepage:
- Size: 17.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# October Contact Plugin
[](https://crowdin.com/project/oc-contact-plugin)
[](http://makeapullrequest.com)
[](https://opensource.org/licenses/MIT)
## Overview
Contact plugin is a component set for websites made with October CMS by freelancers. This plugin may not be compatible with Winter CMS because it use plugin available only on October Marketplace.
With this plugin is possible:
* Set contact information
* Add and adjust the contact information component
* Use logo from Meta plugin in contact component
* Add receivers information and use them in component
And the most important feature:
* Set social icons linked to social media accounts (based on Font Awesome)
## Installation
### Artisan
Use the Laravel's CLI. Traverse to a project's root directory and run the following:
```
php artisan plugin:install codeclutch.meta
php artisan plugin:install zakir.allfonticons
php artisan plugin:install codeclutch.contact
```
## Documentation
### Contact Information
Add information in plugin settings, then add component and write
>{% component 'contactInformation' %}
you can adjust this component in many ways
### Receivers
This component can be used as company team members contact information
Add receivers in plugin settings, import component and write
>{% component 'receivers' %}
### Social Icons
Add social links in plugin settings then open footer (or other file) to import component and write
>{% component 'socialIcons' %}
## Contributing
You are free to contribute in the following ways:
* sending pull requests
* bug reporting and feature requesting by creating issues on plugin [GitHub page](https://github.com/codeclutch-ltd/oc-contact-plugin/issues)
* localization to your language using [Crowdin](https://crowdin.com/project/oc-contact-plugin)
## License
The Contact plugin for October CMS is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).