Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Ethos Invite Graph

A web application to visualize invitation networks on the Ethos platform using interactive graphs and network analysis.

Overview

This project provides a beautiful, modern interface to:

  • Search for Ethos users with intelligent typeahead
  • Visualize invitation connections and trust relationships
  • Analyze network patterns and user interactions
  • Explore the social graph of the Ethos ecosystem

Tech Stack

  • Framework: Fresh (Deno's full-stack web framework)
  • Runtime: Deno
  • Language: TypeScript
  • Styling: Twind (Tailwind CSS-in-JS)
  • Deployment: Deno Deploy
  • API: Ethos Network API v2

Features

✅ Completed

  • Smart User Search: Typeahead search with Ethos API integration
  • Beautiful UI: Modern, responsive design with smooth animations
  • User Selection: Click or keyboard navigation to select users
  • Stub Analysis Page: Foundation for network visualization
  • TypeScript Types: Comprehensive type definitions for Ethos API

🚧 In Development

  • Interactive network graphs using D3.js or similar
  • Invitation flow analysis and statistics
  • Trust relationship visualization
  • Network depth and connection metrics

Getting Started

Prerequisites

  • Deno installed on your system

Installation

  1. Clone the repository:
git clone <repository-url>
cd ethos-invite-graph
  1. Start the development server:
deno task start
  1. Open your browser and navigate to http://localhost:8000

Available Commands

# Start development server with hot reload
deno task start

# Run type checking and linting
deno task check

# Build for production
deno task build

# Preview production build
deno task preview

# Update Fresh framework
deno task update

Project Structure

ethos-invite-graph/
├── routes/
│   ├── api/
│   │   └── search-users.ts      # Ethos API proxy endpoint
│   ├── analysis/
│   │   └── [userkey].tsx        # User analysis page
│   └── index.tsx                # Main landing page
├── islands/
│   └── UserSearch.tsx           # Interactive search component
├── types/
│   └── ethos.ts                 # TypeScript type definitions
├── static/                      # Static assets
├── deno.json                    # Deno configuration
├── fresh.config.ts              # Fresh framework config
├── twind.config.ts              # Styling configuration
└── ethos-api-v2-documentation.md # Complete API documentation

API Integration

The application integrates with the Ethos Network API v2:

  • Base URL: https://api.ethos.network/api/v2
  • User Search: /users/search endpoint for typeahead functionality
  • No Authentication: Currently using public endpoints only

Ethos API Features Used

  • User search with query parameters
  • User profile information
  • Score and trust level data

Future API Integration

  • Activities API for invitation data
  • Reviews API for trust relationships
  • XP API for user engagement metrics

Deployment

Deno Deploy

  1. Install the Deno Deploy CLI:
deno install --allow-read --allow-write --allow-env --allow-net --allow-run --no-check -r -f https://deno.land/x/deploy/deployctl.ts
  1. Deploy to Deno Deploy:
deployctl deploy --project=ethos-invite-graph main.ts

Environment Variables

Currently no environment variables are required. The application uses public Ethos API endpoints.

Development Roadmap

Phase 1: Foundation ✅

  • Project setup with Fresh and Deno
  • User search with typeahead
  • Basic UI and routing
  • Ethos API integration
  • TypeScript types

Phase 2: Network Analysis (Next)

  • Invitation data fetching
  • Graph visualization with D3.js
  • Network statistics calculation
  • Interactive node exploration

Phase 3: Advanced Features

  • Real-time data updates
  • User comparison tools
  • Export functionality
  • Advanced filtering options

Phase 4: Social Features

  • User authentication
  • Saved analyses
  • Sharing capabilities
  • Community insights

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

API Documentation

Complete Ethos API v2 documentation is available in ethos-api-v2-documentation.md.

License

[License details to be added]

Contact

[Contact information to be added]

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages