maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docbrown/docs/backend/algolia.md
rhymes 9210f6793b Improvements on dev docs (#2616) 
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -04:00

2.1 KiB
Raw Blame History

title
Algolia

Algolia for Search

Algolia is a third party service which powers the search. When working with the API is very likely would need to utilize Algolia. You will need to sign up for a free-tier account, retrieve the keys and provide those keys to the Rails application.

Sign up

  1. Go to the Algolia sign up page.

  2. Choose one of the three methods of signing up: email, github or google.

  3. Fill in your information.

    algolia-up-1

  4. Select the datacenter's region.

    algolia-up-2

  5. Fill in or skip the project information.

    algolia-up-3

  6. You are all set up now! You can go to your dashboard.

    algolia-up-4

  7. You can skip the tutorial, we will guide you through the process. Accept the Terms and Conditions.

    algolia-up-5

  8. All good! You can get your API keys now.

Get API keys

  1. Sign up or Sign in to your Algolia account.

  2. From your Dashboard, click on API Keys.

    algolia-1

  3. Change your keys accordingly (name of Algolia key -> name of our ENV variable):

    Application ID -> ALGOLIASEARCH_APPLICATION_ID
Search-Only API Key -> ALGOLIASEARCH_SEARCH_ONLY_KEY
Admin API KEY -> ALGOLIASEARCH_API_KEY

    algolia-2

  4. Done.