An open API service indexing awesome lists of open source software.

https://github.com/unreal-art/console

Console of Unreal OpenAI
https://github.com/unreal-art/console

consol console unreal unrealai

Last synced: 2 months ago
JSON representation

Console of Unreal OpenAI

Awesome Lists containing this project

README

          

# Unreal Console

**Developer Dashboard for API Management & Integration**

Unreal Console is a sleek, modern React-based dashboard that enables businesses and developers to authenticate, generate API keys, and seamlessly integrate their applications with Unreal's OpenAI-compatible backend. It serves as the front-end interface for the OpenAI Router, providing intuitive tools for API management and usage monitoring.

> πŸ”Ύ Connect, authenticate, and deploy AI in minutes.

---

## ✨ Key Features

β€’ **Web3 Authentication** – Secure wallet-based login
β€’ **API Key Management** – Generate, view, and revoke API keys
β€’ **Usage Dashboard** – Real-time monitoring of API consumption
β€’ **Chat Playground** – Test API functionality directly in the console
β€’ **Multi-Page Architecture** – Organized workflow with dedicated sections
β€’ **Interactive Onboarding** – Guided setup for new developers
β€’ **Token-Based Access** – On-chain payment and authentication

---

## πŸ—ΊοΈ Application Structure

```
unreal-console/
β”œβ”€ src/
β”‚ β”œβ”€ components/ # Reusable UI components
β”‚ β”œβ”€ pages/ # Application pages
β”‚ β”œβ”€ lib/ # Core functionality and context
β”‚ β”œβ”€ hooks/ # Custom React hooks
β”‚ β”œβ”€ abis/ # Blockchain contract ABIs
β”‚ └─ config/ # Application configuration
β”œβ”€ public/ # Static assets
└─ tests/ # Playwright E2E tests
```

---

## πŸ“‘ Key Pages

| Page | Description |
|-----------|---------------------------------------------------|
| Home | Landing page with onboarding flow |
| Login | Wallet connection and authentication |
| Dashboard | API key status and usage statistics |
| Chat | Interactive chat completion API testing |
| Settings | API key management and account settings |

---

## πŸ› οΈ Tech Stack

- **Frontend Framework**: React with Vite
- **Styling**: Tailwind CSS with shadcn/ui components
- **State Management**: React Context API
- **Authentication**: Web3 wallet integration via Viem
- **Routing**: React Router
- **Testing**: Playwright for E2E testing

---

## 🧩 Development

```bash
# Setup development environment
npm run setup:min

# Start development server
npm run dev

# Build for production
npm run build

# Run tests
npm run test
```

---

## πŸ”Œ Integration Flow

Unreal Console works as part of a complete API management solution:

1. **Connect** your wallet to authenticate
2. **Configure** your API access with custom keys
3. **Test** API functionality in the playground
4. **Monitor** usage and manage costs
5. **Integrate** your applications with the OpenAI-compatible API

---

## πŸ“œ License

MIT Β© Unreal AI contributors