Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 2.78 KB

README.md

File metadata and controls

62 lines (37 loc) · 2.78 KB
Raw

Memory Cache Browser Client

A browser client for Memory Cache.

Overview

Memory Cache Browser Client is a frontend component of Memory Cache:

  • It sends commands and displays information from Memory Cache Hub.
  • It allows users to view and manage project artifacts, llamafiles, and settings.
  • It allows users to query LLMs using Retrieval Augmented Generation.
  • It allows users to view and manage prompt templates and long-running background tasks.

Installation

Memory Cache Browser Client is included in each release of Memory Cache Hub, so you do not need to install it separately.

To install Memory Cache Hub, follow the instructions in the Memory Cache Hub README.

A Firefox browser extension for Memory Cache that extends its functionality is also available. More information can be found in the main Memory Cache repository.

If you want to build memory-cache-browser-client from source, you can follow the instructions in the sections below.

Development

Memory Cache consists of three separate components:

  • Memory Cache Hub
  • Memory Cache Browser Client
  • Memory Cache Firefox Extension

This repository contains the source code for the Memory Cache Browser Client.

Install prerequisites with:

sudo corepack enable
yarn install

Run the development server with:

yarn parcel src/index.html

The code for interacting with the Memory Cache Hub in src/api is generated from an OpenAPI specification. To regenerate this code, make sure the Memory Cache Hub is running, and then run scripts/regenerate_api.sh.

Working with Memory Cache Hub

There are three ways to work with Memory Cache Hub:

  • By default, a release build of Memory Cache Hub will serve its internal build of Memory Cache Browser Client.
  • Alternatively, you can start Memory Cache Hub with a --client-path argument pointing to the build directory of Memory Cache Browser Client.
  • You can also run Memory Cache Browser Client in development mode (npm start), and it will use the api routes of Memory Cache Hub running on http://localhost:4444.

While you are developing Memory Cache Browser Client, the third option is the most convenient.

Once you are satisfied with your changes, you can test them with a release build of Memory Cache Hub by running npm run build and targeting the build directory with the --client-path argument to Memory Cache Hub.

Further instructions for building releases are in the Memory Cache Hub README