Skip to content

Master #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added Getting started · Front.webloc
Binary file not shown.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
# frontapp.github.io
Front's developer resources

# Getting started
Front supports plugins. A plugin is a small web application that can communicate with Front using a JavaScript API. It allows you to extend Front with new features, making it possible to connect it with other tools you use and optimize the workflow of your team:

+ Show additional data about your customers, that you can pull from your backend, your knowledge or any other source.
+ Take actions directly inside Front on behalf of the user so you can automate a workflow.
+ Link or create entries in your CRM, your knowledge base or any other tool.

![Frontapp Plugin Demo](https://www.filepicker.io/api/file/562i7pXVTbun3NlvVA2Q, "Plugin Demo")

# Plugin demo
You can use any web framework or library you wish: it's just a web page that can communicate with Front. It has to be hosted on your servers and [include our library] (http://dl.frontapp.com/libs/frontjs.min.js):

You can define the location of your plugin in the settings:


Plugin settings

>#HTTPS
>At the moment, your plugin has to be hosted on an HTTPS domain. You can use [https://ngrok.com/](https://ngrok.com/) if you want to quickly serve a local development server over HTTPS.

You can find the documentation for this library here :
- [Controlling Front from your Plugin](http://docs.frontapp.com/v1.0/docs/plugins-controls)
- [Getting updates from Front in your plugin](http://docs.frontapp.com/v1.0/docs/plugins-events)
- [Dialogs](http://docs.frontapp.com/v1.0/docs/plugins-dialogs)
- [Accessing Front's data](http://docs.frontapp.com/v1.0/docs/plugins-data)

We also provide a small sample plugin that shows some basic things you can do using our Javascript API. You can check the code [here](https://github.com/frontapp/frontapp.github.io/).
If you want to test directly, you can even target https://frontapp.github.io/plugin.html in your plugin settings to see what the basic plugin can do.

If you need any help in getting your plugin working, would like more information or a new feature please drop us a line at [email protected] we will be happy to help.

# Troubleshooting
First, don't hesitate to ask [email protected] for help :). Then, you can activate Web Inspector by this command in Terminal (restart the app):

<code>
defaults write com.frontapp.Front WebKitDeveloperExtras -bool true</code>

Then, right-click anywhere in the app and select "Inspect Element".