conf.priv.example.js

/* eslint-disable no-unused-vars, camelcase */

// This is a reference for how conf.priv.js should look.
//
// Copy this file to a new file named "conf.priv.js" and update
// the API keys as needed.
//
// WARNING: Don't `git commit` your actual "conf.priv.js" file if you
// add real API keys to it! Malicious parties frequently scan GitHub for
// these keys and use them for bad stuff. The "conf.priv.js" file is already
// ignored by .gitignore, but just be safe.

// These are private API keys which are required for certain search completions.
// You can obtain them all for free at the supplied links.
const keys = {
  crunchbase:    "", // https://about.crunchbase.com/crunchbase-basic-access/
  google_cs:     "", // https://developers.google.com/custom-search/json-api/v1/overview?hl=en_US
  google_yt:     "", // https://developers.google.com/youtube/v3/docs/
  wolframalpha:  "", // https://products.wolframalpha.com/api/
  domainr:       "", // https://market.mashape.com/domainr/domainr
  alternativeTo: "", // Extract the x-algolia-api-key sent with requests when typing in search box on alternativeto.net

  // ****** Google Custom Search Engines ****** //
  // Can be created at https://cse.google.com/cse
  // Simply create a separate Custom Search Engine for each of the following entries,
  // pasting the provided URL string(s) in the "Sites to Search" field.
  // Then, after creation, go to the control panel for the new Search Engine and copy the
  // Search Engine ID (cx) into the appropriate configuration variable below:
  google_cx_ex: "", // hexdocs.pm/*/master/*.html
  google_cx_af: "", // bbs.archlinux.org/*
  google_cx_al: "", // www.archlinux.org/packages/*/x86_64/*
  google_cx_no: "", // nodejs.org/api/*
  google_cx_cs: "", // chrome.google.com/webstore/*
  google_cx_jq: "", // api.jquery.com/*
  google_cx_gg: "", // godoc.org/*, golang.org/pkg/*
}

// A function which accepts a Digital Object Identifier (DOI) and returns a URL,
// used for accessing academic papers.
// Hint: You probably want to use the service created by Alexandra Elbakyan
const doi_handler = (doi) =>  `https://doi.org/${doi}`

export default { keys, doi_handler }