🎁 Welcome to Ivyi Platform

Ivyi is an innovative platform that changes the way we gift each other! Whether it's a birthday, graduation, wedding, or any milestone worth celebrating, Ivyi handles everything on your behalf - making gifting effortless, thoughtful, and memorable.

📚 Documentation Guide

Get started with our comprehensive documentation:

🔌

Backend API

Express.js API documentation.

Explore Docs
🖥️

Web Application

React Router frontend docs.

Explore Docs
🏗️

Architecture

System design and state machines.

Explore Docs

🎯 Platform Overview

Backend

Node.js with Express and TypeScript

Database

PostgreSQL with Drizzle ORM

Frontend

React Router with TypeScript

Architecture

Domain-Driven Design (DDD) in monorepo

Ivyi is built with modern, scalable technologies designed for performance and reliability.

📁 Project Structure

ivyi/
├── apps/
│ ├── api/ # Backend API service
│ └── web/ # Frontend web application
├── packages/ # Shared packages
│ ├── eslint-config/ # ESLint configurations
│ ├── typescript-config/ # TypeScript configurations
│ └── ui/ # Shared UI components
└── docs/ # Documentation hub

🚀 Getting Started

Prerequisites

Quick Start

  1. Clone the repository

    git clone https://github.com/Emmanuel-Melon/ivyi
cd ivyi

  2. Install dependencies

    npm install

  3. Set up environment variables

    cp .env.example .env
# Edit .env with your configuration

  4. Set up the database

    npm run db:setup
npm run db:migrate
npm run db:seed

  5. Start the development servers

    npm run dev

📋 Quick Links

GitHub Repository

Source code and issue tracking

API Documentation

Interactive API docs with Swagger UI

Web App Guide

Frontend application documentation

Architecture

System design and monorepo structure

🎯 Key Features

🎉 Occasion Management

🎁 Gift Coordination

👥 Social Features