bitcoinsearch / chat-btc

A conversational AI based on technical bitcoin sources
https://chat.bitcoinsearch.xyz/
MIT License
16 stars 13 forks source link
artificial-intelligence bitcoin chatbot knowledge-base

ChatBTC

Welcome to ChatBTC

This is powered by the same backend at bitcoinsearch.xyz, but here you can chat with your favorite sources and authors.


Getting Started

This project is a chat application built using Next.js, Chakra UI. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

  1. Clone the repository

    git clone git@github.com:bitcoinsearch/chat-btc.git
  2. Install NPM packages

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
  3. Add your API keys to a .env.local file in the root directory including:

ES_URL=
ES_AUTHORIZATION_TOKEN=
OPENAI_API_KEY=
OPENAI_MODEL=
ES_PASSWORD=
ES_CLOUD_ID=
ES_INDEX=
ES_INDEX_CORE=
LND_URL=
MACAROON=
JWT_SECRET=

Usage

Visit http://localhost:3000 in your browser to see the application running.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Built With

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Feedback and Contributions

...are welcome!