Skip to content

Commit 85f08df

Browse files
author
Procura AI Dev
committed
Add professional README
1 parent 8886d17 commit 85f08df

1 file changed

Lines changed: 107 additions & 0 deletions

File tree

README.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<p align="center">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/license-AGPLv3-blue?style=flat-square">
4+
<img alt="OpenProcure" src="https://img.shields.io/badge/license-AGPLv3-blue?style=flat-square" height="28">
5+
</picture>
6+
&nbsp;
7+
<img src="https://img.shields.io/github/stars/kanojiautkarsh-programmer/openprocure?style=flat-square" alt="GitHub stars" height="28">
8+
&nbsp;
9+
<img src="https://img.shields.io/badge/types-TypeScript-3178C6?style=flat-square" alt="TypeScript" height="28">
10+
&nbsp;
11+
<img src="https://img.shields.io/badge/stack-NestJS%20%7C%20Next.js%20%7C%20PostgreSQL-1B4D3E?style=flat-square" alt="Stack" height="28">
12+
</p>
13+
14+
<h1 align="center">OpenProcure</h1>
15+
<p align="center"><strong>The open source AI-powered procurement operating system</strong></p>
16+
17+
<p align="center">
18+
Control every dollar your company spends with AI-driven spend intelligence,<br>
19+
automated vendor management, and multi-provider AI assistant capabilities.
20+
</p>
21+
22+
---
23+
24+
## Features
25+
26+
- **AI Assistant** — Multi-provider LLM support (OpenAI, Anthropic, NVIDIA) with automatic cascading, circuit breaker fallback, RAG over your documents, and semantic caching
27+
- **Spend Intelligence** — Automated invoice processing, subscription tracking, contract lifecycle management, and spend analytics
28+
- **Vendor Management** — Centralized vendor directory, risk scoring, performance tracking, and automated renewals
29+
- **Approval Workflows** — Multi-level approval chains with escalation rules and compliance tracking
30+
- **Integrations** — Slack, Microsoft Teams, Gmail, QuickBooks, Xero with bi-directional sync
31+
- **Forecasting & Analytics** — AI-powered spend forecasting, budget tracking, scenario simulation, and anomaly detection
32+
- **BYOK (Bring Your Own Key)** — Connect your own AI provider keys per tenant with encryption at rest
33+
- **Enterprise Ready** — RBAC, audit logging, rate limiting, telemetry, metrics, and health checks built in
34+
35+
## Quick Start
36+
37+
```bash
38+
# Clone and install
39+
git clone https://github.com/kanojiautkarsh-programmer/openprocure.git
40+
cd openprocure
41+
npm install
42+
43+
# Start dependencies (Docker required)
44+
docker compose up -d
45+
46+
# Copy environment and fill in your keys
47+
cp .env.example .env
48+
49+
# Generate Prisma client
50+
npm run db:generate
51+
52+
# Start development
53+
npm run dev
54+
```
55+
56+
### One-command install (Windows)
57+
58+
```powershell
59+
.\install.ps1
60+
```
61+
62+
## Architecture
63+
64+
```
65+
openprocure/
66+
├── apps/
67+
│ ├── api/ # NestJS backend (REST API + Webhooks)
68+
│ └── web/ # Next.js frontend (App Router + Cloudflare)
69+
├── packages/
70+
│ ├── ui/ # Shared UI components (Radix + Tailwind)
71+
│ ├── database/ # Prisma schema + PostgreSQL client
72+
│ ├── shared/ # Zod schemas + shared TypeScript types
73+
│ └── config/ # ESLint + TypeScript shared configs
74+
└── scripts/ # Dev tooling and test setup
75+
```
76+
77+
### Tech Stack
78+
79+
| Layer | Technology |
80+
|---|---|
81+
| Backend | NestJS 11, TypeScript, Prisma 6, PostgreSQL + pgvector |
82+
| Frontend | Next.js 15, React 19, Tailwind CSS 4, Framer Motion |
83+
| Auth | Clerk (OAuth, SSO, JWT) |
84+
| AI | OpenAI, Anthropic Claude, NVIDIA — multi-tenant BYOK |
85+
| Queue | BullMQ (Redis) |
86+
| Vector DB | pgvector for RAG embeddings |
87+
| Testing | Jest, Vitest, Supertest, k6 |
88+
| Deploy | Render, Cloudflare Pages, Docker |
89+
90+
## AI Assistant Pipeline
91+
92+
```
93+
User Query → Sanitize → Rate Limit → Token Budget → Classify
94+
→ Embed → Semantic Cache (hit? return) → RAG Retrieval
95+
→ Compress → LLM (cascading: OpenAI → Anthropic → NVIDIA)
96+
→ Guardrails → Response
97+
```
98+
99+
Each stage is instrumented with OpenTelemetry spans and Prometheus metrics.
100+
101+
## Contributing
102+
103+
OpenProcure is AGPLv3 licensed and open for contributions. See [CONTRIBUTING.md](./CONTRIBUTING.md) and [CLA.md](./CLA.md) for details.
104+
105+
## License
106+
107+
AGPL-3.0-only — see [LICENSE](./LICENSE). Commercial licenses available for enterprise deployments that require proprietary integration.

0 commit comments

Comments
 (0)