Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

Grinning-Cat-RAG/grinning-cat-admin

Repository files navigation

Grinning Cat Admin UI

A modern web-based administration interface for the Grinning Cat Core framework. This admin UI provides a user-friendly interface to manage, configure, and monitor your Grinning Cat AI assistant instances.

Features

  • 🎯 Dashboard Overview - Real-time monitoring of Grinning Cat instances
  • 🔧 Configuration Management - Easy-to-use interface for system settings
  • 🧩 Plugin Management - Install, configure, and manage plugins
  • 👥 User Management - Handle user accounts and permissions
  • 📊 Analytics & Logs - Monitor conversations and system performance
  • 🔐 Authentication & Security - Secure access control and user management
  • 🎨 Modern UI - Clean, responsive interface built with modern web technologies

Prerequisites

  • Python 3.11 or higher
  • pip and venv for dependency management
  • Running instance of Grinning Cat Core

Installation

1. Clone the repository

git clone https://github.com/matteocacciola/grinning-cat-admin.git
cd grinning-cat-admin

2. Create and activate virtual environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies

make install

4. Set up environment variables

Copy the example environment file and configure it:

cp .env.example .env

Edit .env with your settings.

5. Run the application

make run

The admin interface will be available at http://localhost:8501

Configuration

Connecting to Grinning Cat Core

The admin UI connects to your Grinning Cat Core instance via REST API. Configure the connection in your .env file:

GRINNING_CAT_API_URL=http://your-grinning-cat-instance:1865
GRINNING_CAT_API_KEY=your-api-key

Authentication

The admin interface supports multiple authentication methods:

  • Local authentication: Username/password stored in the admin database
  • JWT tokens: Secure token-based authentication
  • Integration with Grinning Cat Core: Sync users from your Cat instance

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes and add tests
  4. Commit your changes: git commit -m 'Add amazing feature'
  5. Push to the branch: git push origin feature/amazing-feature
  6. Open a Pull Request

License

This project is licensed under GPL3.

Support

Acknowledgments


Made with ❤️ for the Grinning Cat community

About

Grinning Cat Admin UI

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages