Skip to content

Commit

Permalink
Description
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseAlbDR authored Apr 7, 2024
1 parent 76edd84 commit fa39118
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@
## Documentación:
https://backend.adoptaunpeludo.com/api/docs

## Descripción

El backend de adoptaunpeludo.com se compone de un a API y varios micro servicios:

[**API**](https://github.com/Adoptaunpeludo/backend):
- Auth: Endpoints relacionados con la autentificación y autorización de usuarios sobre los diferentes recursos a los que tienen acceso.
- Users: Endpoints relacionados con el CRUD de usuarios.
- Animals: Endpoints relacionados con el CRUD de animales.
- Chats: Endopints relacionados con la obtención de información acerca de los diferentes chats que tengan los usuarios.

[**Notification-service**](https://github.com/Adoptaunpeludo/notification-service):
- Servidor de websocket encarcado de las notificaciones en tiempo real y de la gestión de las private rooms y los mensajes de chats entre los usuarios.

[**Email-service**](https://github.com/Adoptaunpeludo/email-service):
- Servicio encargado de enviar emails a los usuarios como el email de validación, de recuperación de contraseña o notificaciones cuando el usuario está offline.

[**Chatbot-service**](https://github.com/Adoptaunpeludo/chatbot-service):
- Servicio encargado de la funcionalidad de Asistente de la web, utiliza un agente creado con LangChain que hace busquedas vectoriales en una Base de datos almacenada en Supabase y que previamente ha sido poblada con embeddings con la documentación de la Web para que así el Asistente pueda responder preguntas acerca de ella.

**NOTA:** Más información acerca de cada servicio en el link a su propio repositorio.



## Instalacion

1. Clonar el repo, movernos al directorio e instalar las depencencias:
Expand Down

0 comments on commit fa39118

Please sign in to comment.