Skip to content

Dictionary web application developed with React, Vite and TypeScript. Tested with Sonarqube.

License

Notifications You must be signed in to change notification settings

misicode/Dictionary_App

Repository files navigation

Logo Icon

Dictionary App

Aplicación de diccionario
Ver Demo | Reportar Bug | Solicitar Feature


📖 Acerca del repositorio

Aplicación web desarrollada con React que consume la API de Free Dictionary para obtener la definición de palabras en inglés, y la API de Pexels para mostrar imágenes asociadas a la palabra.

Construido con

Herramienta Descripción Versión
React Biblioteca de JavaScript para construir las interfaces de usuario 18.2.0
Vite Herramienta de Frontend para construir el proyecto 5.2.0
TypeScript Lenguaje de programación fuertemente tipado para escribir código 5.2.2
SonarQube Plataforma para evaluar el código fuente 10.5
NPM Administrador de paquetes para instalar las dependencias 10.5.0
Visual Studio Code Editor de código para el proyecto 1.89.1

Vista previa

🚀 Iniciando el proyecto

Para poner en funcionamiento una copia local de este repositorio, siga los siguientes pasos.

Requisitos previos

Obligatorio

NodeJS >= 16.X
NPM >= 8.X

Opcional

Git
Visual Studio Code

Instalación y configuración

  1. Obtenga una clave API gratuita en Pexels.

  2. Descargue o clone este repositorio.

    git clone https://github.com/misicode/DictionaryApp.git
  3. Instale todos los paquetes NPM.

    npm install
  4. Cree el archivo .env como copia del archivo .env.template e ingrese la clave de su API.

    # PEXELS
    VITE_PEXELS_API_KEY=your_pexels_api_key
  5. Ejecute el proyecto en modo desarrollo.

    npm run dev
    

🔍 Evaluando la calidad de código

Requisitos previos

SonarQube >= 9.X

Configuración

  1. Inicie el servicio de SonarQube.

  2. Edite la sección de configuración de Sonar en el archivo sonar-project.properties con sus credenciales de acceso.

    # Sonar configuration
    sonar.host.url=http://localhost:9000/
    sonar.login=admin
    sonar.password=Admin1
  3. Ejecute el escaneo de Sonar.

    npm run sonar
    

Resultados

💼 Licencia

Distribuido bajo la licencia MIT. Consulte LICENSE.txt para obtener más información.

🌸 Contacto

Desarrollado por Alessandra Mincia

Misicode GitHub LinkedIn

📝 Agradecimientos

La idea de este proyecto surgió como iniciativa del workshop "SheCodes React", de SheCodes. Para obtener más información detallada de este programa visite el siguiente enlace.

About

Dictionary web application developed with React, Vite and TypeScript. Tested with Sonarqube.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published