Tutorials

This document set provides tutorial documentation for the Peek Platform.

Contents:

• Peek Plugin Tutorial
  • First Steps
    • Introduction
    • Check Setup
    • Plugins and the Platform
  • Scaffolding From Scratch
    • Plugin File Structure
    • Install in Development Mode
  • Add Documentation
    • Documentation File Structure
    • Add Admin Documentation
    • Add User Documentation
    • Add Developer Documentation
    • Check Peek Server Config
    • Check Peek Client Config
    • Viewing Documentation
    • What Next?
  • Add Server Service
    • Server File Structure
    • Running on the Server Service
  • Add Client Service
    • Client File Structure
    • Running on the Client Service
  • Add Agent Service
    • Agent File Structure
    • Running on the Agent Service
  • Add Storage Service
    • Storage File Structure
    • Adding a StringInt Table
    • Adding a Settings Table
  • Add Admin Service
    • Admin File Structure
    • Running on the Admin Service
  • Add Mobile Service
    • Mobile File Structure
    • Running the Mobile Web App
    • Running the Mobile NativeScript App
  • Add Desktop Service
    • Desktop File Structure
  • Add Tuples
    • Objective
    • Tuples File Structure
    • Test Python Services
    • Tuples Frontends and TypeScript
  • Add Tuple Loader
    • Outline
    • Server Service Scaffold
    • Test Python Services
    • StringInt Server Service
    • StringInt Admin Service
    • Test StringInt Tuple Loader
    • Settings Server Service
    • Settings Admin Service
    • Test Settings Tuple Loader
  • Add Offline Storage
    • Outline
    • Mobile Service
  • Add Observables
    • Outline
    • Objective
    • Server Service Setup
    • Client Service Setup
    • Mobile Service Setup
    • Add Tuple Provider
    • Admin Update Notify
    • Add Mobile View
    • Testing
    • Offline Observable
    • Add More Observables
  • Add Actions
    • Outline
    • Objective
    • Add Python Tuples
    • Add TypeScript Tuples
    • Server Service Setup
    • Client Service Setup
    • Mobile Service Setup
    • Add Mobile View
    • Testing
    • Offline Observable
  • Add Vortex RPC
    • Outline
    • What is RPC
    • Server RPC Setup
    • Agent Calling Server RPC
    • Agent RPC Setup
    • Server Calling Agent RPC
    • Testing
  • Add Plugin Python API
    • Overview
    • Same Service APIs Only
    • What are APIs
    • Setup Server API
    • Use Server API
    • Testing
  • Add Plugin TypeScript APIs (TODO)
    • Overview
    • How To
  • Use Plugin APIs (TODO)
    • Overview
  • Add Worker Service
    • Outline
    • Add Package _private/worker
    • Add File WorkerEntryHook.py
    • Add Package _private/worker/tasks
    • Add File RandomNumber.py
    • Edit peek_plugin_tutorial/__init__.py
    • Edit plugin_package.json
    • Running on the Worker Service
    • Push work from server to worker service
    • Run run_peek_server
  • Challenges
    • Challenge #1: Lifecycle Methods
    • Challenge #2: Admin Plugin Tab
    • Challenge #3: Client Tasks
    • Challenge #4: VortexJs Tuple Actions
    • Challenge #5: Worker Service
• ReStructuredText Cheat Sheet
  • Sections
  • Header 2
    • Header 3
  • Inline Markups
  • Files
  • Reference Links
  • URL Link
  • Code Block
  • Bullets
  • Numbered Lists
  • Images
  • Admonitions
  • TOC tree
  • Docstring Format