Skip to content

README.md

Latest commit

 

History

History
94 lines (71 loc) · 3.77 KB

README.md

File metadata and controls

94 lines (71 loc) · 3.77 KB

Lingüíst

Lingüíst es un proyecto de chat desarrollado con React, Express, Node.js y PostgreSQL. Este proyecto está diseñado para fomentar el aprendizaje de idiomas al permitir a los usuarios comunicarse con personas de otros países que hablan el idioma que desean aprender.

Además de la funcionalidad básica de chat, Lingüíst también integra una inteligencia artificial para traducción de texto en tiempo real. Esto permite a los usuarios traducir los mensajes del chat instantáneamente en caso de encontrar palabras o frases que no entiendan, o los "slangs" de cada país.

Características principales

  • Chat en tiempo real: Permite a los usuarios comunicarse de forma instantánea con personas de otros países que hablan el idioma que desean aprender.

  • Traducción integrada: La integración de una inteligencia artificial permite traducir los mensajes del chat en tiempo real, facilitando la comprensión de los usuarios.

  • Aprendizaje interactivo: Los usuarios pueden practicar y mejorar sus habilidades lingüísticas a través de conversaciones reales con hablantes nativos del idioma objetivo.

  • Aprendizaje avanzado: Los usuarios mejoran su gramática y estructura del lenguaje con el chat de IA especializado.

Instalación

Para ejecutar localmente el proyecto, sigue estos pasos:

  1. Clona este repositorio en tu máquina local:

    git clone https://github.com/Spiegelin/Linguist.git

  2. Instala las dependencias del cliente y del servidor utilizando npm y yarn:

    1. Si no tienes yarn:
    npm install --global yarn
    1. Navega a cada carpeta e instala las dependencias
    cd backend
npm install 
cd ../frontend
yarn install

  3. Crea un archivo .env para las variables de entorno:

    DB_USER=postgres
DB_PASSWORD=_tu_contraseña_
DB_PORT=5432
APP_PORT=8000
JWT_SECRET=agrega_tu_secreto_puede_ser_palabras_random
COOKIE_SECRET=mismo_caso_aqui
GOOGLE_CLIENT_ID=id_de_google_cloud_console
GOOGLE_CLIENT_SECRET=secret_proyecto_de_google_cloud_console
GOOGLE_CALLBACK_URL=http://localhost:8000/api/auth/google/callback
FACEBOOK_APP_ID=id_facebook_developer
FACEBOOK_APP_SECRET=secret_facebook_developr
FACEBOOK_CALLBACK_URL=http://localhost:8000/api/auth/facebook/callback
GITHUB_CLIENT_ID=ig_github_developer
GITHUB_CLIENT_SECRET=secret_github_developer
GITHUB_CALLBACK_URL=http://localhost:8000/api/auth/github/callback
FRONTEND_URL=http://localhost:5173
OPENAI_API_KEY=sk-...

  4. Configura la base de datos PostgreSQL (usando pgadmin) y actualiza las credenciales de conexión en el archivo backend/database/db.js.

  5. Ejecuta el servidor y el cliente en terminales separadas:

    # En el directorio 'backend'
npm start

# En el directorio 'frontend'
npm run dev

  6. Abre tu navegador web y navega a http://localhost:5173 para ver la aplicación en funcionamiento.

Contribuir

¡Contribuciones son bienvenidas! Si deseas contribuir a Lingüíst, sigue estos pasos:

  1. Haz un fork del repositorio.
  2. Crea una nueva rama (git checkout -b feature/nueva-caracteristica).
  3. Realiza tus cambios y haz commit de ellos (git commit -am 'Agrega una nueva característica').
  4. Haz push a la rama (git push origin feature/nueva-caracteristica).
  5. Abre un pull request.

Créditos

Lingüíst es creado y mantenido por

Licencia

Este proyecto está bajo la Licencia MIT. Consulta el archivo LICENSE para obtener más detalles.