https://github.com/ravendb/samples-hr
https://github.com/ravendb/samples-hr
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ravendb/samples-hr
- Owner: ravendb
- License: mit
- Created: 2025-12-02T11:36:16.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-01-27T15:43:55.000Z (6 months ago)
- Last Synced: 2026-01-28T02:19:02.128Z (6 months ago)
- Language: C#
- Size: 824 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Human Resources Assistant
## Overview
A sample application providing a human resources assistant chatbot. It leverages [RavenDB](https://ravendb.net) database and [RavenDB AI](https://docs.ravendb.net/ai-integration/ai-integration_start).
## Live Demo
A live hosted version of this application can be found here:
**[https://hr.samples.ravendb.net](https://hr.samples.ravendb.net)**
Please bear in mind, this application, for sake of simplicity of the deployment, is deployed in XYZ region. This can impact the latency you perceive. (remove if not applicable).
We do clean the environment from time to time.
## Features used
The following RavenDB features are used to build the application:
1. [AI Agents](https://docs.ravendb.net/ai-integration/ai-agents/ai-agents_start) - RavenDB's built-in AI agent framework powers the HR chatbot with tool calling and conversation management
1. [Time Series](https://ravendb.net/features#:~:text=dimensional%20vector%20embeddings-,TIME%20SERIES,-Distributed%20Time%20Series) - tracking API usage per session and globally for rate limiting visualization
1. [Vector Search](https://docs.ravendb.net/ai-integration/vector-search/vector-search_start) - semantic search for HR policies, issues, and documents using `vector.search(embedding.text(...))`
1. [Attachments](https://docs.ravendb.net/document-extensions/attachments/what-are-attachments) - storing employee signature images on documents
1. [Counters](https://docs.ravendb.net/document-extensions/counters/overview) - tracking total prompt and completion tokens used
1. [Document Expiration](https://docs.ravendb.net/server/extensions/expiration) - automatic cleanup of expired sessions and conversations
## Technologies
The following technologies were used to build this application:
1. [RavenDB 7.1](https://ravendb.net) - document database with AI integration
1. [.NET Aspire](https://learn.microsoft.com/en-us/dotnet/aspire/get-started/aspire-overview) - cloud-ready stack for distributed applications
1. [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) / [ASP.NET Core 10](https://learn.microsoft.com/en-us/aspnet/core/)
1. [Node.js 22](https://nodejs.org/en/download) / [React 18](https://react.dev/)
1. [SignalR](https://learn.microsoft.com/en-us/aspnet/core/signalr/introduction) - real-time API usage broadcasting
## Architecture
The application consists of:
- **Backend (ASP.NET Core)** - REST API with rate limiting middleware, SignalR hub for real-time updates
- **Frontend (React)** - chat interface with real-time API usage visualization
- **RavenDB** - proivdes AI agents natively, stores employees, policies, documents, conversations, and usage metrics via time series and counters
Rate limiting is implemented at two levels:
- **Session-based** - limits requests per user session (30-second window)
- **Global** - limits total requests across all users (15-minute window)
## Run locally
If you want to run the application locally, please follow the steps:
1. Check out the GIT repository
1. Install prerequisites:
1. [.NET 10.x](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
1. [Node.js 22.x](https://nodejs.org/en/download)
1. Set required environment variables:
```bash
# Required
SAMPLES_HR_OPENAI_API_KEY=
# Required - developer or enterprise license
SAMPLES_HR_RAVEN_LICENSE=
# Optional (rate limiting - defaults provided)
SAMPLES_HR_MAX_GLOBAL_REQUESTS_PER_15_MINUTES=100
SAMPLES_HR_MAX_SESSION_REQUESTS_PER_30_SECONDS=5
```
1. `npm install` in `/sampleshr-frontend` to get all the needed packages
1. Run the .NET Aspire AppHost:
```bash
aspire run
```
1. Open the Aspire dashboard and click "Seed data" to populate the database with sample employees, policies, and documents
## Community & Support
If you spot a bug, have an idea or a question, please let us know by rasing an issue or creating a pull request.
We do use a [Discord server](https://discord.gg/ravendb). If you have any doubts, don't hesistate to reach out!
## Contributing
We encourage you to contribute! Please read our [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
## License
This project is licensed with the [MIT license](LICENSE).