Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
# SynapseStack
# SynapseStack

SynapseStack is a lightweight framework for building retrieval-augmented generation (RAG) services. It aims to simplify data ingestion, embedding, querying, and serverless deployment for LLM-powered applications.

## Objectives

- Provide an easy-to-use toolkit for RAG pipelines.
- Support serverless export with minimal configuration.
- Encourage architectural experimentation via ADRs.

## Prerequisites

- [Node.js](https://nodejs.org/) 18 or higher
- npm (bundled with Node.js) or Yarn

```bash
node --version
```

## Installation

Clone the repository and install dependencies:

```bash
git clone https://github.com/yourorg/SynapseStack.git
cd SynapseStack
npm install
```

## Basic Usage

### rag-cli

Use the command line interface to manage data and run queries locally:

```bash
npx rag-cli ingest ./data
npx rag-cli query "What is SynapseStack?"
```

### Serverless export

Build a deployable package for AWS Lambda:

```bash
npx rag-cli export --provider lambda --output dist
```

## Contributing

Contributions are welcome! Please open issues to discuss features or fixes, then submit a pull request from your fork.

1. Fork this repository.
2. Create a feature branch.
3. Commit your changes and open a pull request.

Documentation lives in the `docs/` directory, and Architecture Decision Records can be found in `docs/adr/`.

## License

Released under the [Apache 2.0](LICENSE) license.