Skip to content

DavidGDA/code-fu-readme-badge

Repository files navigation

Code-Fu README Badge

Desarrollado por

CodeFU staff CodeFU staff

Descripción del Proyecto

Code-Fu README Badge es un proyecto diseñado para proporcionar insignias personalizadas para los staffs de Code-FU.

Prerequisitos

Para poder utilizar este proyecto en un entorno local, se necesitan tener instalados los siguientes programas:

  • Node.js 22.14.0+
  • npm 10.8.3+
  • Python 3.13.2+
  • Git

Instalación

Para instalar el proyecto junto a sus dependencias, sigue estos pasos:

git clone https://github.com/DavidGDA/code-fu-readme-badge.git
cd code-fu-readme-badge
npm install

# Cree un entorno virtual de python y instale sus dependencias
python -m venv .venv
python -m pip install -r requirements.txt

Uso

Para ejecutar el servidor de desarrollo, ejecute el siguiente comando:

npm run dev

Navegue hacia localhost:3000 deberia de observar "App is running"

Uso con Docker

Para ejecutar el proyecto utilizando Docker, sigue estos pasos:

  1. Asegúrate de tener Docker instalado en tu sistema. Puedes descargarlo e instalarlo desde aquí.

  2. Construye la imagen de Docker:

    docker build -t code-fu-readme-badge .
  3. Ejecuta el contenedor de Docker:

    docker run -p 3000:3000 code-fu-readme-badge
  4. Navega hacia localhost:3000 en tu navegador. Deberías ver "App is running".

Contribución

Si deseas contribuir a este proyecto, por favor 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 (git commit -m 'Añadir nueva característica').
  4. Sube tus cambios (git push origin feature/nueva-caracteristica).
  5. Abre un Pull Request.