Skip to content

pharmanet-org/technical

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PharmaNet Technical Documentation

Internal developer documentation for the PharmaNet platform — covering architecture, features, data models, and guides for the Flutter mobile app, React web portals, and Supabase backend.

Built with Zensical — a static site generator with Material for MkDocs–like theming.

Tech Stack

Technology Description
Zensical Static site generator (.toml configuration)
Markdown Content written in standard .md
Theme Zensical default (MkDocs-inspired, dark/light palette)
Extensions Admonitions, footnotes, tabs, task lists, Mermaid diagrams, code annotations, emoji
Font Inter (body), JetBrains Mono (code)

Architecture

docs/
├── docs/                               # All documentation content
│   ├── index.md                        # Landing page — About PharmaNet
│   │
│   ├── overview/                       # Platform overview (5 pages)
│   │   ├── index.md
│   │   ├── architecture.md
│   │   ├── tech-stack.md
│   │   └── database-schema.md
│   │
│   ├── mobile/                         # Flutter mobile app (30+ pages)
│   │   ├── index.md
│   │   ├── getting-started.md
│   │   ├── architecture.md
│   │   │
│   │   ├── features/                   # 16 feature pages
│   │   │   ├── index.md
│   │   │   ├── auth.md
│   │   │   ├── onboarding.md
│   │   │   ├── home.md
│   │   │   ├── products.md
│   │   │   ├── pharmacies.md
│   │   │   ├── cart.md
│   │   │   ├── orders.md
│   │   │   ├── payments.md
│   │   │   ├── promotions-offers.md
│   │   │   ├── notifications.md
│   │   │   ├── profile.md
│   │   │   ├── wishlist.md
│   │   │   ├── chat.md
│   │   │   ├── reviews.md
│   │   │   ├── pharmacist.md
│   │   │   └── featured-subscriptions.md
│   │   │
│   │   ├── models/                     # 9 data model pages
│   │   │   ├── index.md
│   │   │   ├── user.md
│   │   │   ├── product.md
│   │   │   ├── order.md
│   │   │   ├── promotion.md
│   │   │   ├── notification.md
│   │   │   ├── cart.md
│   │   │   ├── address.md
│   │   │   ├── chat.md
│   │   │   └── review.md
│   │   │
│   │   └── providers/                  # 8 Riverpod provider pages
│   │       ├── index.md
│   │       ├── auth.md
│   │       ├── products.md
│   │       ├── orders.md
│   │       ├── cart.md
│   │       ├── notifications.md
│   │       ├── promotions.md
│   │       ├── location.md
│   │       └── settings.md
│   │
│   ├── admin-web/                      # Admin web app (13+ pages)
│   │   ├── index.md
│   │   ├── getting-started.md
│   │   ├── architecture.md
│   │   ├── features/                   # 12 feature pages
│   │   │   ├── index.md
│   │   │   ├── dashboard.md
│   │   │   ├── users.md
│   │   │   ├── products.md
│   │   │   ├── categories.md
│   │   │   ├── orders.md
│   │   │   ├── payments.md
│   │   │   ├── cms.md
│   │   │   ├── promotions.md
│   │   │   ├── reports.md
│   │   │   ├── settings.md
│   │   │   ├── featured-products.md
│   │   │   └── subscriptions.md
│   │   └── services.md
│   │
│   ├── seller-web/                     # Seller web app (10+ pages)
│   │   ├── index.md
│   │   ├── getting-started.md
│   │   ├── architecture.md
│   │   ├── features/                   # 10 feature pages
│   │   │   ├── index.md
│   │   │   ├── dashboard.md
│   │   │   ├── products.md
│   │   │   ├── orders.md
│   │   │   ├── payments.md
│   │   │   ├── promotions-offers.md
│   │   │   ├── settings.md
│   │   │   ├── featured-products.md
│   │   │   ├── subscriptions.md
│   │   │   └── reports.md
│   │   └── services.md
│   │
│   ├── supabase/                       # Supabase backend (16+ pages)
│   │   ├── index.md
│   │   ├── schema.md
│   │   ├── views.md
│   │   ├── rls-policies.md
│   │   ├── realtime.md
│   │   ├── migrations.md
│   │   └── tables/                     # 14 table documentation pages
│   │       ├── profiles.md
│   │       ├── sellers.md
│   │       ├── products.md
│   │       ├── categories.md
│   │       ├── orders.md
│   │       ├── notifications.md
│   │       ├── promotions.md
│   │       ├── banners.md
│   │       ├── subscriptions.md
│   │       ├── featured-products.md
│   │       ├── addresses.md
│   │       ├── reviews.md
│   │       ├── chats.md
│   │       └── settings.md
│   │
│   └── guides/                         # Developer guides (6 pages)
│       ├── index.md
│       ├── setup-local.md
│       ├── setup-database.md
│       ├── contribute.md
│       ├── debugging.md
│       └── deployment.md
│
├── site/                               # Generated static HTML output
├── zensical.toml                       # Site configuration
└── README.md                           # This file

Features

  • Comprehensive Documentation — Covers all platform components: mobile app, admin web, seller web, Supabase backend
  • 70+ Pages — Deep documentation of features, architecture, data models, providers, services, and database schema
  • Mermaid Diagrams — Architecture and flow diagrams rendered inline
  • Code Annotations — Interactive code examples with line highlighting
  • Dark/Light Mode — Palette toggle between default and slate themes
  • Full-Text Search — Built-in search with highlighting
  • Responsive — Mobile-friendly navigation with sections and indexes
  • MkDocs-Style Navigation — Hierarchical nav with instant loading, breadcrumbs, and table of contents

Navigation Structure (from zensical.toml)

  1. Overview — About, Platform Overview, Architecture, Tech Stack, Database Schema
  2. Mobile App (Flutter) — Getting Started, Architecture, 16 Features, 9 Models, 8 Providers
  3. Admin Web App — Getting Started, Architecture, 12 Features, Services
  4. Seller Web App — Getting Started, Architecture, 10 Features, Services
  5. Supabase Backend — Schema, 14 Tables, Views, RLS Policies, Realtime, Migrations
  6. Guides — Local Setup, Database Setup, Contributing, Debugging, Deployment

Allowed Users

User Type Access
Developers (internal team) Read/write via git
Public Can be deployed and accessed publicly

Hardcoded Credentials (Test Purposes Only)

None. This documentation project contains only placeholder/template values in .env.example files referenced in guide pages:

  • SUPABASE_URL=https://your-project.supabase.co
  • SUPABASE_ANON_KEY=your-anon-key
  • CHAPA_SECRET_KEY=your-chapa-key

These are templates — no real credentials are hardcoded.

Prerequisites

  • Zensical CLI installed globally

How to Run

# 1. Navigate to the project
cd docs

# 2. Start the development server
zensical serve

# Or build the static site:
zensical build

Preview at the URL shown by Zensical (typically http://localhost:8000).

Available Commands

Command Description
zensical serve Start development server with live reload
zensical build Build static site to site/ directory
zensical serve --port 8080 Start on custom port

Configuration

Key configuration in zensical.toml:

site_name = "PharmaNet Technical Docs"
site_description = "Complete technical documentation for PharmaNet..."
site_author = "PharmaNet Team"

License

Proprietary — PharmaNet, Alyah Software © 2026

About

technical documentation

Resources

Contributing

Stars

Watchers

Forks

Contributors