A simple, customizable receptionist iPad app built with Smooch. Receive a message on Slack when someone is at the reception.
git clone https://github.com/AcroMace/receptionkit.git
cd receptionkit
- Sign up with Smooch and copy the App ID from Settings
- Configure Slack with Smooch
- Disable Automatic Channel Archiving when configuring Smooch. If you don't do this, your receptionist channel will be archived.
- Open
ReceptionKit.xcworkspace
with Xcode - Navigate to
Config.swift
- Replace
Config.Smooch.AppToken
with the App Token from Smooch - Build and run the app (
⌘R
)
Replies
You can send a message to the iPad by using /sk [message]
inside the iPad channel (called sk-receptionist
by default). If you want the message to be sent in real time, you need to configure push notifications. Otherwise, there may be up to a 5 second delay before the message arrives.
Name
You can set the name of how the receptionist appears in Slack by changing Config.Slack.Name
.
Picture
Smooch uses Gravatar to set the user's profile pictures. If you want to set a profile picture, you must set a Gravatar for an email and set Config.Slack.Email
to that email.
Channel name
A new channel will be created for each iPad running the app. You can rename the channel using the /rename new-channel-name
in Slack.
ReceptionKit uses the contacts on the iPad for searching contacts when a visitor presses the i know the name of the person i am here to see
button.
You can sync the iPad with contacts from Google, Outlook, or use any standard way of syncing contacts with iOS.
If you use /sk #image
in Slack, it will post an image from the front-facing camera. You can change the command by changing Config.Photos.ImageCaptureCommand
. You can also disable the command by setting Config.Photos.EnableCommand
to false
.
The app will also post a picture when someone interacts with the iPad. You can disable this behaviour by setting SendOnInteraction
to false
.
Background colour
The background colour and the navigation bar colour can be changed in Config.swift
by changing Config.Colour.Background
and Config.Colour.NavigationBar
, respectively, to the colours' hex values.
Image assets
The image assets can be changed by replacing the images in Images.xcassets
. The resolutions of the images are:
Image type | Resolution |
---|---|
Company logo | 800 x 88 |
Delivery logos | 800 x 800 |
Navigation bar
Logo
The logo is displayed only in the first view and can be disabled by setting Config.General.ShowLogo
to false
. Otherwise, you can replace the placeholder logo with your own image (see Image Assets)
Language toggle
The English/French language toggle is enabled by default. You can turn it off by setting Config.General.ShowLanguageToggle
to false
.
Launch screen
If you wish to customize the launch screen, you must change the LaunchScreen.xib
file.
Doorbell noise
You can disable the doorbell sound when someone checks in by setting Config.General.PlayDoorBell
to false
. You can also change the default sound played by replacing ReceptionKit/doorbell.mp3
with the mp3 file you wish to play instead.
The current sound effect is Bell1.wav from pac007, licensed CC0.
- The icons on the buttons are from Font Awesome. You can replace the icon in
Icons.swift
by changing the Unicode values. - The first time you search for a contact, you will have to give the app permission to access the device's contact list.