notifito Documentation

Version: 1.0.0
Contact: turker@gmail.com
Repository: https://github.com/turkerince/notifito

Welcome

Welcome to the notifito documentation. This documentation covers:

• Architecture: System design and data model
• API: Edge and internal API references
• Guides: Widget integration, seller onboarding, deployment
• Development: Setup, testing, contributing
• Reference: Attribute types, configuration

Quick Links

• Architecture Overview
• Edge API Reference
• Widget Integration
• Deployment Guide
• Development Setup

Getting Started

1. Read the Architecture Overview to understand the system
2. Review the Edge API Reference for API details
3. Follow the Widget Integration guide to embed the widget
4. Check the Deployment Guide for production setup

Documentation Sections

Architecture

• Overview - System architecture and design decisions
• Data Model - Database schema and relationships
• Communication - Event bus and service communication

API

• Edge API - Public API reference with code examples
• Internal API - Core internal API reference
• OpenAPI Specification - Machine-readable API spec

Guides

• Widget Integration - How to embed the widget
• Seller Onboarding - Dashboard user guide
• Deployment - Docker Compose deployment guide

Development

• Setup - Local development environment
• Testing - Testing strategy and guide
• Contributing - Code style and contribution guide

Reference

• Attribute Types - The seven attribute types
• Configuration - Environment variables reference