Code-Fu README Badge es un proyecto diseñado para proporcionar insignias personalizadas para los staffs de Code-FU.
Para poder utilizar este proyecto en un entorno local, se necesitan tener instalados los siguientes programas:
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
Para ejecutar el servidor de desarrollo, ejecute el siguiente comando:
npm run dev
Navegue hacia localhost:3000 deberia de observar "App is running"
Para ejecutar el proyecto utilizando Docker, sigue estos pasos:
-
Asegúrate de tener Docker instalado en tu sistema. Puedes descargarlo e instalarlo desde aquí.
-
Construye la imagen de Docker:
docker build -t code-fu-readme-badge .
-
Ejecuta el contenedor de Docker:
docker run -p 3000:3000 code-fu-readme-badge
-
Navega hacia localhost:3000 en tu navegador. Deberías ver "App is running".
Si deseas contribuir a este proyecto, por favor sigue estos pasos:
- Haz un fork del repositorio.
- Crea una nueva rama (
git checkout -b feature/nueva-caracteristica
). - Realiza tus cambios y haz commit (
git commit -m 'Añadir nueva característica'
). - Sube tus cambios (
git push origin feature/nueva-caracteristica
). - Abre un Pull Request.