📝(readme) small improvements

- remove the old handmade logo
- fix the dependencies
- add small introduction
This commit is contained in:
Quentin BEY
2025-08-26 17:00:25 +02:00
parent 0f45d2e896
commit 86bcebadf8
4 changed files with 22 additions and 9 deletions
+20 -6
View File
@@ -16,6 +16,24 @@
</p>
**Warning:** This project is in active development and in a very early stage. Breaking changes may occur at any time.
## Yet another AI chatbot
Conversations is an open-source AI chatbot designed to be simple, secure and privacy-friendly.
Why another AI chatbot? Because we want to be able to fully control our data and the way we interact with AI.
We want to have a very friendly end-user interface and code, and we want to be able to easily customize the
chatbot to our needs.
We leverage open-source projects such as [Vercel&lsquo;s AI SDK](https://ai-sdk.dev/) and [Pydantic AI](https://ai.pydantic.dev)
and only assemble them in a way that makes sense for us and allows us to focus on the product.
This assistant's purpose is also to be integrated into the "La Suite numérique" ecosystem of tools for public services.
Any help to improve the project is very welcome!
### Self-host
🚀 Conversations is easy to install on your own servers
@@ -32,9 +50,7 @@ You can test Conversations on your browser by visiting this => TBD
### Run Conversations locally
> ⚠️ The methods described below for running Conversations locally is **for testing purposes only**.
> It is based on building Conversations using [Minio](https://min.io/) as an S3-compatible storage solution.
> Of course you can choose any S3-compatible storage solution.
> ⚠️ The methods described below for running Conversations locally is **for testing purposes only**.
**Prerequisite**
@@ -154,9 +170,7 @@ docs
### Stack
Conversations is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [Vercel&lsquo;s AI SDK](https://ai-sdk.dev/) and [OpenAI Agents SDK](https://github.com/openai/openai-agents-python). We thank the contributors of all these projects for their awesome work!
Conversations is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [Vercel&lsquo;s AI SDK](https://ai-sdk.dev/) and [Pydantic AI](https://ai.pydantic.dev). We thank the contributors of all these projects for their awesome work!
### Gov ❤️ open source
Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 39 KiB

+1 -2
View File
@@ -44,7 +44,6 @@ Production deployments differ significantly from development environments. The t
| Object Storage (optional) | **External or self-hosted** | Can use AWS S3, Azure Blob, Google Cloud Storage, or self-hosted MinIO |
| Django API (+ Celery) | **1 3 GB** | Production workloads with background tasks and higher concurrency |
| Static Files (Nginx) | **< 200 MB** | Serves Next.js build output and static assets; no development overhead |
| Y-Provider (y-websocket) | **200 MB 1 GB** | Scales with concurrent document editing sessions |
| Nginx (Load Balancer) | **< 200 MB** | Reverse proxy, SSL termination, static file serving |
### Production Architecture Notes
@@ -53,7 +52,7 @@ Production deployments differ significantly from development environments. The t
- **Authentication**: Any OIDC-compatible provider can be used instead of self-hosted Keycloak
- **Object Storage**: External services (S3, Azure Blob) or self-hosted solutions (MinIO) are both viable
- **Database**: Consider PostgreSQL clustering or managed database services for high availability
- **Scaling**: Horizontal scaling is recommended for Django API and Y-Provider services
- **Scaling**: Horizontal scaling is recommended for Django API service
### Minimal Production Setup (Core Services Only)
+1 -1
View File
@@ -20,7 +20,7 @@ classifiers = [
"Programming Language :: Python :: 3.12",
]
description = "An application to chat with your own AI."
keywords = ["Django", "AI", "Chatbot", "OpenAI", "Conversations"]
keywords = ["Django", "AI", "Chatbot", "OpenAI", "Pydantic AI", "Conversations"]
license = { file = "LICENSE" }
readme = "README.md"
requires-python = ">=3.12"