Skip to content

Welcome to Timely Capsule, your ultimate platform for sending and receiving messages across time!

Notifications You must be signed in to change notification settings

S-Mubarak/timelycapsule-web

 
 

Repository files navigation

ourKairos

ourKairos is an open-source platform for creating and delivering time-locked digital capsules—messages, media, and crypto gifts that unlock only at a specific moment in the future.

It reintroduces anticipation to digital communication by combining reliable Web2 infrastructure with blockchain-powered payments.

Originally built on Starknet, ourKairos is actively being migrated to the Stellar network to enable faster confirmations, lower transaction costs, and broader accessibility—while preserving a pragmatic hybrid Web2/Web3 architecture.


✨ Why ourKairos?

In a world dominated by instant messages and disposable content, ourKairos is built around intentional delivery.

Capsules are sealed, stored securely, and revealed only when the time is right.

Use cases include:

  • Future messages to yourself or others
  • Birthday and anniversary surprises
  • Scheduled video or audio drops
  • Crypto gifts delivered at meaningful moments

The platform is designed to work just as well for casual users as it does for crypto-native users, supporting:

  • Guest access
  • Registered accounts
  • Subscription-powered perks

🚀 Core Features

  • Time-Locked Capsules
    Define exactly when a capsule becomes accessible

  • Multi-Media Support
    Text, images, videos, and crypto gifts

  • Hybrid Web2 / Web3 Architecture

    • Web2 for storage, integrity, and performance
    • Web3 for payments, subscriptions, and ownership
  • Flexible Access
    Guest users and authenticated accounts

  • Custom Delivery Controls
    Recipients, unlock dates, reminders, and visibility

  • Secure & Scalable
    Built to grow with usage and contributors


🏗 Architecture Overview

ourKairos is built as a modular monorepo using Turborepo, ensuring scalability and clean separation of concerns.

Layer Technology
Monorepo Turborepo + pnpm workspaces
Frontend Next.js (App Router)
Backend Express.js + TypeScript
Database MongoDB
Blockchain Stellar (Payments & Time Bounds)
Services Standalone Node.js workers

📁 Repository Structure

ourKairos/
├── apps/
│   ├── web/        # Next.js frontend application
│   ├── api/        # Express.js backend API
│   └── stellar/    # Stellar payment & verification service
│
├── packages/
│   ├── config/     # Shared TSConfig and ESLint rules
│   ├── types/      # Shared TypeScript interfaces
│   └── utils/      # Shared helper functions
│
├── turbo.json      # Turborepo pipeline configuration
├── package.json
└── README.md

🧰 Getting Started

Prerequisites

  • Node.js ≥ 18

  • pnpm

    npm install -g pnpm
  • MongoDB (local or Atlas)


Installation

  1. Clone the repository

    git clone https://github.com/your-org/ourKairos.git
    cd ourKairos
  2. Install dependencies

    pnpm install
  3. Configure environment variables

    Create a .env file in apps/api/:

    MONGO_URI=mongodb://localhost:27017/ourkairos
    PORT=3001

▶️ Run Locally

Start the full stack (Frontend, API, and Stellar service):

pnpm dev

🏗 Build for Production

pnpm build

🔌 API Highlights

Capsules

  • POST /capsules — Create a new capsule
  • GET /capsules/:id — Retrieve capsule details
  • PATCH /capsules/:id — Seal or update a capsule

System

  • GET /health — API & database health check

🤝 Contributing

ourKairos is fully open-source and welcomes contributors across Web2, Web3, and product engineering.

How to Contribute

  1. Fork the repository
  2. Create a feature branch from main
  3. Pick an open issue or propose a new one
  4. Keep pull requests focused and well-documented
  5. Always run pnpm dev before submitting

Contribution Guidelines

  • Shared Logic: Place reusable logic in packages/
  • Types: Define all data models in packages/types
  • Linting: Run pnpm lint before pushing

Resources

💬 Support & Community

For questions, design discussions, or pre-PR clarifications:

👉 Telegram: https://t.me/ourKairos


📄 License

MIT License

About

Welcome to Timely Capsule, your ultimate platform for sending and receiving messages across time!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 82.3%
  • JavaScript 13.0%
  • CSS 4.7%