Skip to content
Snippets Groups Projects
README.md 1.35 KiB
Newer Older
Laurian Gridinoc's avatar
Laurian Gridinoc committed
# Project Setup and Running Instructions

## Prerequisites

- Python 3.11
- uv (Python package manager)
- pip (Python package installer)

## Setup

1. Create a virtual environment:

```bash
python -m venv venv
```

2. Install dependencies:

```bash
make install
```

## Running the Project

### Development Mode

To run the project in development mode with langgraph:

```bash
langgraph dev
```

### Running the Server

To start the server:

```bash
python src/server.py
```

## Environment Variables

Make sure to set up your environment variables in a `.env` file before running the project. You can copy the example file and modify it with your settings:

```bash
cp .env.example .env
```

## Development

The project uses:
- LangGraph for graph-based workflows
- Python FastAPI server

For more detailed documentation about specific components, please check the corresponding source files in the `src` directory.

## References

This project is built upon and inspired by several sources:

### Server Implementation
- React agent implementation based on https://github.com/langchain-ai/react-agent
- Document state based on https://github.com/langchain-ai/retrieval-agent-template/blob/main/src/retrieval_graph/state.py
- FastAPI server implementation based on [LangGraph Discussion #1604](https://github.com/langchain-ai/langgraph/discussions/1604#discussioncomment-11899868)