Skip to content

chrisputnam9/quixer

Repository files navigation

Quixer

The Quicker Search Tool

Application

About Page

Inspiration / Motivation

  • Save clicks, searching, loading, go directly to the info you want
  • Quicksilver or Alfred for the web
  • Custom Search Engines with useful defaults and syncing
  • DuckDuckGo Bangs with better discovery, usability, and customization

Contributing Default Services

New default service suggestions are welcome via issue or pull request of default-config.js.

Suggestions will be evaluated based on:

  • Popularity
  • Usefulness
  • Comfort
  • Creativity / Uniqueness
  • Whim

Basically, the services built-in will aim to be the core, most popular, most useful, and demonstrate the capabilities of Quixer. Anything else can be added/installed by users on-demand.

Full Local Development Setup

This will not be needed for most contributors (ie. not needed just to contribute a service - test that in config import instead)

  1. Install Node
  2. Install Caddy
  3. Install mkcert
  4. Add line to hosts file 127.0.0.1 quixer.dev
  5. Run mkcert -install to set up local CA
  6. Go to dev/ssl - eg. cd dev/ssl
  7. Run mkcert -cert-file quixer.dev.pem -key-file quixer.dev-key.pem quixer.dev localhost
  8. Copy .env.sample to .env and fill in details as needed
    • Go to Google Dev Console
    • Create a new Google Drive API project for yourself - "Quixer DEV" to use in development - keep the API key secret, fill in details in .env file
  9. Run npm install
  10. Follow the Development Workflow steps below

Optional

  1. Set up your text editor. Steps for vim

Development Workflow

Note: alternatively, use start.sh

  1. npm run dev in one terminal tab or screen buffer
  2. caddy run in another terminal tab or screen buffer
  3. Visit https://quixer.dev in browser