Documentation Index for Plugn Developer Onboarding#

1. Plugn Quickstart (Day 1)

   • Introduction to the Plugn ecosystem.
   • Setting up your development environment for documentation and code.
   • Previewing and deploying documentation changes using Mintlify CLI.
   • Editing docs with MDX and React components.
   • Reference: Quickstart guide

2. plugn-dashboard-ionic – Setup & API Config

   • Native plugin configuration: camera, file system, geolocation, Google auth.
   • App ID: io.plugn.dashboard.
   • OneSignal plugin setup for notifications (Ionic native docs).
   • iOS build: remove ios from capacitor in plugn-device/package.json.
   • Android keystore management: keytool commands for signing.
   • Docker setup: docker compose up, build and run images, port mappings.
   • Accessing the app: http://localhost:3000/login (browser), port 8100 for ionic serve.
   • CircleCI integration with Slack notifications using SLACK_ACCESS_TOKEN.
   • Payment API references: Tap Payments, Pricing API.
   • Reference: plugn-dashboard-ionic README

3. plugn-ionic – Setup & API Config

   • Environment configuration: API endpoints, restaurant UUIDs.
   • Docker deployment and environment variable setup.
   • Reference: plugn-ionic environment config

4. plugn-store & plugn-store-community – Setup

   • Documentation preview and publishing using Mintlify starter kit.
   • General setup instructions for store variants.
   • Reference: plugn-store docs

5. Plugn Integrations (Slack, S3, Payments)

   • Slack integration for deployment notifications via CircleCI (SLACK_ACCESS_TOKEN).
   • S3 bucket configuration for file storage:
     • Temporary bucket: plugn-public-anyone-can-upload-24hr-expiry.s3.amazonaws.com
     • Permanent bucket: plugn-uploads-dev-server.s3.amazonaws.com
   • Payment integration with Tap Payments API.
   • Reference: plugn-dashboard-ionic environment config

6. Plugn Repositories – Priority & Status

   • Overview of Plugn repositories: dashboard, store, device, microservices, etc.
   • Repository structure and code organization.
   • Active maintenance and priority inferred from root-level docs and contribution files.
   • No formal priority/status file; check main README or issue tracker for current status.

This index is ordered for new developer onboarding, starting with a high-level quickstart, followed by setup and API configuration for each main project, integration guides, and ending with repository context. For further details, consult the referenced documentation files and configuration sources.