Change npm packaging structure and fix contributing info (#16 )

* change the package to workspace concept

* add provider name and change default model

* add the node_modules to git ignore

* change the npm runs to use workspace

* fix the start scripts to use the workspace

* update the uv.lock

* updated instructions

* update the docker build to use the npm workspace

* Update package-lock.json after merge to sync workspace dependencies

* fix merge conflict

2025-12-12 14:14:19 -05:00

1.4 KiB

Raw Blame History

Contributing to Hindsight

Thanks for your interest in contributing to Hindsight!

Getting Started

Fork and clone the repository

git clone git@github.com:vectorize-io/hindsight.git
cd hindsight

Set up your environment:
```
cp .env.example .env
```
Edit the .env to add LLM API key and config as required

Install dependencies:

# Python dependencies
uv sync --directory hindsight-api/

# Node dependencies (uses npm workspaces)
npm install

Development

Running the API locally

./scripts/dev/start-api.sh

Running the Control Plane locally

./scripts/dev/start-control-plane.sh

Running the documentation locally

./scripts/dev/start-docs.sh

Running tests

cd hindsight-api
uv run pytest tests/

Code style

Use Python type hints
Follow existing code patterns
Keep functions focused and well-named

Pull Requests

Create a feature branch from main
Make your changes
Run tests to ensure nothing breaks
Submit a PR with a clear description of changes

Reporting Issues

Open an issue on GitHub with:

Clear description of the problem
Steps to reproduce
Expected vs actual behavior
Environment details (OS, Python version)

Questions?

Open a discussion on GitHub or reach out to the maintainers.

1.4 KiB Raw Blame History