Skip to content

README.md

Latest commit

 

History

History
67 lines (45 loc) · 1.12 KB

README.md

File metadata and controls

67 lines (45 loc) · 1.12 KB

Synapse

An LLM platform for interacting with Hugging Face models. Requires a Hugging Face API token (BYOK).

Requirements

  • Node.js 18+
  • A Hugging Face account with an API token

Installation

git clone https://github.com/your-org/hubchat.git
cd hubchat
npm install

Configuration

cp .env.example .env
PORT=3000

User-supplied Hugging Face API tokens are saved to a users profile. accessed only when interacting with the model.

Running

npm run dev

App runs at http://localhost:3000.

Usage

  1. Enter your Hugging Face API token when prompted
  2. Search for a model available on hugging face
  3. Start a chat session

Supported Models

Any model available via the Hugging Face Inference API with chat or text generation support.

Project Structure

hubchat/
├── src/
│   ├── api/      # Hugging Face API client
│   ├── chat/     # Chat logic
│   └── ui/       # Frontend
├── public/
└── .env.example

Roadmap

  • Chat
  • More features coming

License

MIT