Skip to main content

ForgeJS CLI para scaffolding de proyectos JavaScript/TypeScript

Project description

ForgeJS

🚀 ForgeJS es un scaffolding para proyectos JavaScript/TypeScript que permite crear proyectos personalizados usando plantillas alojadas en GitHub.

Con ForgeJS puedes:

  • Elegir frameworks disponibles.
  • Seleccionar plantillas de proyectos.
  • Ver la estructura de carpetas antes de crear el proyecto.
  • Agregar carpetas personalizadas.
  • Ejecutar npm install automáticamente.
  • Agregar componentes predefinidos a tu proyecto usando un comando en la terminal (Fase alpha).
  • Instalar y configurar librerías populares (como TailwindCSS) mediante un solo comando.

🔹 Requisitos

  • Node.js y npm (para proyectos Node/React)
  • Python 3.7 o superior
  • Internet para descargar las plantillas y componentes

🔸 IMPORTANTE

  • De momento solo contiene plantillas con JavaScript (JS)
    (TypeScript será implementado en una próxima actualización)
  • Framework disponible: React
  • Cada carpeta de cada plantilla contiene un archivo .MD para entender la estructura y el contenido.

� Tokens de GitHub (opcional pero recomendado)

ForgeJS descarga las plantillas desde GitHub.
GitHub limita las peticiones a 60 por hora si no estás autenticado.

Para evitar ese límite, puedes configurar tu propio token personal:

  1. Crea un token en GitHub desde
    👉 https://github.com/settings/tokens
    (solo necesitas habilitar el permiso public_repo)

  2. Luego configúralo en tu sistema:

💻 En Windows PowerShell:

setx FORGEJS_GITHUB_TOKEN "ghp_tuTokenAqui"

🐧 En macOS / Linux:

export FORGEJS_GITHUB_TOKEN="ghp_tuTokenAqui"

Cierra y vuelve a abrir la terminal.

ForgeJS detectará automáticamente el token y lo usará para realizar las descargas sin restricciones.

⚠️ Si no configuras el token, ForgeJS seguirá funcionando, pero con el límite público de 60 peticiones por hora (por IP).


🔨 Crear proyectos

Crear proyectos con ForgeJS es muy sencillo.
Solo necesitas ejecutar uno de los siguientes comandos:

forgejs

o

forgejs create

Luego podrás:

  • Elegir el framework disponible.
  • Ver las plantillas disponibles.
  • Visualizar la estructura de carpetas antes de descargarla.
  • Confirmar la plantilla y crear tu proyecto automáticamente.

📦 Componentes (Fase Alpha)

ForgeJS permite agregar componentes ya creados a un proyecto existente mediante:

forgejs add <nombre_del_componente>

Ejemplo:

forgejs add LoginForm

📁 Esto descargará el componente desde el repositorio de ForgeJS y lo colocará automáticamente dentro de la carpeta src/components del proyecto actual.


🎨 Instalación de librerías y frameworks

ForgeJS también permite instalar y configurar librerías populares con un solo comando.
Actualmente se encuentra en fase experimental, con soporte inicial para TailwindCSS.

Comandos disponibles

forgejs install tailwindcss

O sus alias más cortos:

forgejs i tailwindcss

o

forgejs install tcss

💡 Ejemplo (React + Vite)

forgejs install tailwindcss

👉 Instalará y configurará automáticamente TailwindCSS en un proyecto React creado con Vite, modificando los archivos vite.config.js e index.css.

💡 Ejemplo (Angular)

Si el proyecto fue creado con Angular, ForgeJS detectará el framework automáticamente y ejecutará la configuración correspondiente (TailwindCSS para Angular, con postcss y autoprefixer).


⚙️ Configuración del proyecto

Cada proyecto creado con ForgeJS genera un archivo interno .forgejs.json que guarda la información de la plantilla y el framework utilizados.
Esto permite a ForgeJS reconocer el entorno cuando agregas componentes u otras funciones futuras.

Ejemplo:

{
  "framework": "react",
  "template": "basic_template"
}

🧩 Próximas características

  • Soporte completo para TypeScript (TS)
  • Nuevos frameworks: Vue, Svelte, Angular, Next.js, etc.
  • Instaladores inteligentes para librerías como Bootstrap, Framer Motion, Chakra UI, etc.
  • Biblioteca de componentes dinámica y personalizable
  • Sistema de plugins ForgeJS (extensiones creadas por la comunidad)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

forgejs-1.0.1a2.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

forgejs-1.0.1a2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file forgejs-1.0.1a2.tar.gz.

File metadata

  • Download URL: forgejs-1.0.1a2.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for forgejs-1.0.1a2.tar.gz
Algorithm Hash digest
SHA256 dd7d7866876dad3a18df9cebf422a5e6106d28dc12a4f2851b09677571d29102
MD5 13ac2fe0d0f0eb53f7db4b8c374b1fb2
BLAKE2b-256 15930323fea4a3392db1453a81a5667d437743c323ca64d34c16dc077e9381b3

See more details on using hashes here.

File details

Details for the file forgejs-1.0.1a2-py3-none-any.whl.

File metadata

  • Download URL: forgejs-1.0.1a2-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for forgejs-1.0.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 08b7124f9dfd3d9321fa4fcba637a22af44c80721576967c8462da28d60cc5bc
MD5 0a24226d1255490f72775904c45228a5
BLAKE2b-256 48052936eee10604c302521e0120ac9058b44e614bedbe97e490f67852520a2f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page