Skip to content
Open
Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Component-Specific Setup

Each component has its own AGENTS.md with setup details:
- **extralit-server/AGENTS.md** - Backend server setup
- **extralit-frontend/AGENTS.md** - Frontend UI setup
- **extralit/AGENTS.md** - Python SDK setup
Each component has its own `CLAUDE.md` with setup details:
- **extralit-server/CLAUDE.md** - Backend server setup
- **extralit-frontend/CLAUDE.md** - Frontend UI setup
- **extralit/CLAUDE.md** - Python SDK setup

## Prerequisites

Expand Down
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ The contributor guide covers:

## Development setup

Refer to our [development setup documentation](https://docs.extralit.ai/latest/getting_started/development_setup/) for instructions on setting up your local environment.
Refer to our [development setup documentation](https://docs.extralit.ai/latest/getting_started/development_setup/) for instructions on setting up your local environment, and the per-component `CLAUDE.md` files (`extralit-server/CLAUDE.md`, `extralit-frontend/CLAUDE.md`, `extralit/CLAUDE.md`) for component-specific commands.

### Choose a dev environment

Pick the environment that matches what you're working on:

- **Tilt** (`Tiltfile`) — Recommended for active full-stack development. Brings up server + frontend + dependencies with live reload. Use this when iterating on backend and frontend together.
- **`docker-compose.yaml`** — Quickest way to run a complete stack against fixed images. Use when you need a reproducible environment to demo or test against, but don't need code-level reload.
- **`examples/deployments/k8s/`** — Reference manifests for production-style Kubernetes deployments. Use as a starting point for staging/prod, not for local iteration.
- **Bare `uv sync` + `npm run dev`** — Fastest inner loop when only one component is in scope. See the per-component `CLAUDE.md` files.

Thank you for contributing to Extralit! 🚀
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ pip install extralit

If you already have a server deployed and login credentials, obtain your API key in the User Settings. You can manage your extraction workspace through the CLI with:

```base
```bash
extralit login --api-url http://<extralit_server_instance>
# You will be prompted an API key to login to your account
```
Expand Down
12 changes: 12 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Examples

End-to-end snippets for using Extralit. Each subdirectory targets a specific feature or deployment scenario.

| Example | Component | What it shows |
|---|---|---|
| [custom_field](custom_field) | SDK / frontend | Custom field types — interactive chat (`interactive_chat.html`), and table fields (`table_field.ipynb`). |
| [deployments](deployments) | Server | Reference [Docker](deployments/docker) and [Kubernetes](deployments/k8s) deployment configs. See [deployments/README.md](deployments/README.md). |
| [document_extraction](document_extraction) | SDK | Notebook walkthrough for setting up a workspace and running extraction (`setup_workspace.ipynb`). |
| [webhooks](webhooks) | Server | Minimal webhooks integration ([basic-webhooks](webhooks/basic-webhooks)). |

Notebooks assume a running Extralit server and SDK install — see the root [README.md](../README.md) and [AGENTS.md](../AGENTS.md) for setup.
2 changes: 1 addition & 1 deletion extralit-frontend/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/arrow-down.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/arrow-up.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/assign.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/bulk-mode.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/change-height.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/check.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/chevron-down.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/chevron-left.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/chevron-right.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/chevron-up.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/clear.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/close.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/code.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/copy.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/danger.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/dark-theme.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/discard.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/draggable.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/expand-arrows.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/exploration.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/export.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/external-link.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/external.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/filter.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/focus-mode.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/hand-labeling.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/high-contrast-theme.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/import.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/info.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/kebab.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/light-theme.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/link.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/log-out.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/matching.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/math-plus.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/meatballs.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/minimize-arrows.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/no-matching.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/pen.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/plus.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/progress.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion extralit-frontend/assets/icons/question-answering.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* coding=utf-8
* Copyright 2021-present, the Recognai S.L. team.
* Copyright 2024-present, Extralit Labs, Inc..
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Loading
Loading