M
M
Magny resources
Search…
⌃K

Quick start

Whether you’re a developer or a business user, this guide gives you the chance to try Magny's search and discovery products for yourself.

Create an account

If you’re a product manager or developer who wants to see how Magny works, sign-up for an account, find out how you can start with a project, and read about how analytics can help measure the success of your in-app search implementation.
When you sign up, try to do things out by yourself. You'll first be greeted by a few questions and a project name, which will be used as the initial project. Then, a tour guide will explain how to start using Magny.

Install Magny to your application

After creating your account, just have a look around to get the basics how Magny works. Go ahead and add a few categories and commands to the project you created.
Now it is time to test Magny. Go to Project --> Settings. Copy the following script and insert it into your website's HTML source code, between the <head> and </head> and tags.
Now, when you reload the page, Magny will fetch the data and initialize itself. You can now test the commands you have entered, and update Magny as required.

Creating projects and adding commands

While it is possible to open Magny via the shortcut cmd/ctrl-K, it is highly recommended to use a visual search (launcher) for end users to start searching for anything and discover the widget.
Once commands are entered, and the corresponding project is set from Draft to Live, the app user will be able to first boot (load the widget) and then init the widget.
When booted, corresponding JS code (widget) and configurations will be downloaded from a public JS repo and Magny server respectively, but cannot be run. When init’ed, it becomes visible with cmd/ctrl-K.
The admin is strongly suggested to use a visible inline search bar to initiate Magny. In this case, when a user clicks on the searchbar, Magny search panel will open.
The platform shouldn’t have any issues working with different frameworks (e.g React, Next.js, Angular etc). There might be some considerations, tips and tricks to use with those frameworks, however there are no blockers using them.
Note that all commands are available for all users defined in the dashboard. In the future “Availability conditions” will be presented, for which a command will be shown when an availability is met (for example, user is capable of doing an action like creating a group).