¶ Trabajar con GitHub localmente en tu PC
Esta solución para trabajar en GitHub es bastante más compleja que la opción previa explicada en este manual, trabajar directamente desde la web de GitHub. Por esta razón sólo se recomienda para usuarios que tengan ciertos conocimientos de Git y GitHub. Es una opción mucho más flexible y potente que nos permite editar Urantiapedia de modos más rápidos y de mayor alcance. Además, permite ejecutar unas herramientas, llamadas Urantiapedia Tools, que realizan tareas automatizadas muy rápidas.
Esta debería ser la opción más recomendable para los usuarios Administradores o Editores Jefe, mientras que la opción de trabajar directamente desde la web de GitHub se recomienda para los usuarios Editores Asistentes.
Lo primero para trabajar localmente en GitHub es realizar varias instalaciones de software que vamos a explicar. Luego daremos unos consejos de configuración.
Se asume que antes de seguir estos pasos ya nos hemos creado una cuenta en GitHub y hemos hecho las necesarias copias (forks) de los proyectos de Urantiapedia a n uestra cuenta, tal y como se detalla en Primeros pasos en GitHub.
¶ Instala Git en tu PC
- Navega a https://git-scm.com/.
- Descarga el instalador para tu sistema operativo. Tienes un tutorial completo de cómo instalarlo en diferentes SO aquí: Instalar Git. En Windows usa el instalador y deja las opciones por defecto.
- Comprueba que Git está correctamente instalado ejecutando esto en un terminal:
git --version. Si devuelve el número de versión entonces Git está correcto. - Ejecuta los siguientes comandos en un terminal (Git instala un terminal llamado Git CMD que puedes usar) para configurar tu identidad en Git, con tu nombre y correo. Esto es necesario para que Git te configure como contribuidor de código.
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
¶ Instala Node.js en tu PC
Node.js es un requisito para hacer funcionar las Urantiapedia Tools. Si no las vas a ejecutar nunca te puedes saltar este paso, aunque es recomendable.
- Navega a https://nodejs.org/.
- Descarga Node.js. Usa la versión LTS actual disponible.
- Instala con las opciones por defecto.
- Comprueba que Node.js está correctamente instalado. Abre un terminal y ejecuta
node -v. Si aparece el número de versión entonces Node.js está correcto.
¶ Instala VS Code y GitLens
Es muy recomendable el uso de Visual Studio Code.
- Navega a https://code.visualstudio.com/.
- Descarga e instálalo. Durante la instalación es recomendable marcar la opción «Añadir acción ‘Abrir con Code’ al menú contextual de los directorios» si eres un usuario de Windows.
- Ábrelo. La primera vez que se abre puedes establecer algunas opciones. Sáltalas.
- En VS Code haz click en el botón Extensiones en la botonera lateral izquierda. Es muy recomendable instalar una extensión llamada «GitLens». Suele estar en la lista de las extensiones más populares. Localízala y haz click en el botón de instalar.
- Ahora tendrás un nuevo botón para GitLens en la botonera de la izquierad de VS Code. Haz click en él y click en el botón Welcome (Quick setup). Se abre la página Welcome. Es recomendabble seleccionar Source control layout como vista por defecto. Esto hace que GitLens se fusione con el panel Source control por defecto de VS Code.
¶ Clona los proyectos de Urantiapedia
- Abre la web de GitHub y navega a tu cuenta.
- Abre tus copias de los proyectos (forks) de la Urantiapedia que deberías tener creados.
- En la página principal de cada copia haz clic en el menú verde llamado Code y en él haz click para copiar la URL del proyecto, algo como
https://github.com/<username>/urantiapedia.gityhttps://github.com/<username>/urantiapedia-backup.git.
- Abre VS Code, abre el panel Source control y haz click en Clone repository.
- En la casilla de texto que aparece teclea o pega la ruta copiada antes.
- Selecciona Clone from GitHub.
- Haz click en Allow in the GitHub extension to sign in.
- Aparece una página web pidiendo autorización de VS Code para acceder GitHub. Haz click en Continue.
- Haz click en Authorize github.
- Ahora se te redirige a una nueva página web donde se abre un mensaje. Haz click en Open VS Code.
- Ahora haz click en Open para permitir el uso de la ruta proporcionada. Si algo va mal repite desde el punto 4.
- Cuando se muestre el nombre del repositorio de tu proyecto de la Urantiapedia en la central de comandos selecciónalo. Aparecerá un cuadro de diálogo preguntando por una carpeta. Selecciona cualquier carpeta o crea una para el proyecto.
- Espera unos minutos para que VS Code clone el repositorio. Finalmente haz click en Open repo. También haz click en Yes, I trust the authors.
- El proyecto se abrirá correctamente.
- Realiza estos mismos pasos para cada proyecto, para urantiapedia y para urantiapedia-backup.
¶ Configurar las Urantiapedia Tools
Las Urantiapedia Tools es una aplicación de escritorio desarrollada en JavaScript con Electron. Sirve para ejecutar procesos muy rápidos que modifican cientos de páginas al tiempo. Si no vas a necesitar usarla puedes saltar este paso. Para instalarla y ejecutarla sigue estos pasos:
- Abre el proyecto urantiapedia en VS Code. Para ello puedes hacerlo de dos modos:
- Abre VS Code. Selecciona File > Open folder. Selecciona la carpeta raíz del proyecto, la que contiene el fichero
package.json. - Opcionalmente, en Windows puedes abrir el proyecto mediante el menú contextual de la carpeta raíz y seleccionar Abrir con Code.
- Abre un terminal usando Terminal > New Terminal. Asegúrate de que el terminal está abierto en la carpeta raíz del proyecto.
- Para instalar las dependencias de Urantiapedia Tools ejecuta:
npm install. Espera hasta que todas se instalan.
- El proyecto se configura con una configuración de ejecución por defecto. Presiona F5 para ejecutar la aplicación o en el terminal ejecuta
npm run start. - La aplicación se abre. Por defecto se abre una ventana Dev Tools para poder depurar. Si no estás desarrollando puedes ignorarla o cerrarla.
¶ Enlaces externos
- Urantiapedia Tools - proyecto en GitHub
- Urantiapedia-backup - proyecto en GitHub
- Fundación Urantia
- Blue Fields
- Wiki.js