Skip to content

Home

Jump to bottom
Nathan Grilliot edited this page Feb 10, 2026 · 3 revisions

NQ Wiki

Welcome to the NQ project wiki! This documentation will help you install, configure, and use NQ.

About NQ

NQ (iN Queue) is a smart media recommendation system that helps you decide what to watch, play, read, or listen to next. Instead of endlessly scrolling through streaming services or your game library, NQ learns your preferences and suggests content you'll actually enjoy.

How it works:

  1. Connect your media accounts (Spotify, Steam, YouTube, etc.) (coming soon!)
  2. NQ syncs your viewing/playing/listening history
  3. A graph database maps relationships between media items
  4. Get personalized recommendations based on your actual preferences

Quick Start

  1. User Guide - Complete beginner-friendly walkthrough
  2. Installation Guide - Step-by-step setup instructions
  3. FAQ - Common questions and troubleshooting
  4. API Data Sources - Connect Spotify, Steam, YouTube, and more
  5. Tech Stack - Technologies and architecture
  6. Usage Guide - Development workflow and advanced features

Documentation Overview

For End Users

  • User Guide

    • Installation from scratch
    • Connecting your media accounts
    • Getting recommendations
    • Troubleshooting

  • Installation Guide

    • Installing prerequisites (Go, Node.js, Neo4j)
    • Setting up backend and frontend
    • Verification steps

  • FAQ

    • Installation help
    • API and configuration questions
    • Troubleshooting common issues
    • Privacy and data questions

For Developers

  • API Data Sources

    • Detailed documentation for all 10 integrated APIs
    • How to get credentials for each service
    • Authentication methods
    • Rate limits and best practices

  • Tech Stack

    • Backend technologies (Go, GraphQL, Neo4j)
    • Frontend technologies (React Native, Expo, TypeScript)
    • Database schema
    • Development tools

  • Usage Guide

    • Running the application
    • Development workflow
    • Testing procedures
    • Common development tasks

Project Overview

  • Backend: Go-based GraphQL API with Neo4j graph database
  • Frontend: React Native mobile app built with Expo
  • Goal: Simplify media discovery through intelligent, personalized recommendations

Key Features

  • Unified Tracking - Aggregate media consumption across multiple platforms
  • Smart Recommendations - Graph-based engine analyzes relationships and preferences
  • 10+ Integrations - Connect Spotify, Steam, YouTube, Twitch, and more (coming soon!)
  • Cross-Platform - React Native app works on iOS and Android
  • GraphQL API - Flexible, self-documenting API for custom integrations

Media Coverage

NQ supports tracking and recommendations for:

  • Music
  • Games
  • Video
  • Books

See API Data Sources for complete details on each integration.

Project Structure

nq/
├── backend/          # Go GraphQL API server
│   ├── integrations/ # Third-party service integrations (Spotify, Steam, etc.)
│   ├── metadata/     # Media metadata providers (TMDB, IGDB, Open Library)
│   ├── db/           # Database models and repositories
│   └── graph/        # GraphQL schema and generated code
└── nq-frontend/      # React Native mobile app (Expo)

Getting Help

Installation problems: See the Installation Guide or FAQ

API credentials: See API Data Sources

Tech stack: See Tech Stack

*Development: See Usage Guide

Still stuck? Submit an issue on the GitHub repository

System Requirements for Self Hosting

  • Operating System: Windows 10+, macOS 10.15+, or Linux
  • Go: Version 1.25.1 or higher
  • Node.js: Version 18 or higher
  • Database: Neo4j Aura (cloud) or Neo4j Desktop (local)

License

NQ is open source software released under the MIT License. See the LICENSE file in the repository for details.

Clone this wiki locally