Descripción

Documentación técnica para el testnet LatamLink latamlink.io

Este sitio web es creado usando https://docusaurus.io/, una herramienta para mantener documentación técnica de proyectos de código libre.

Contribuciones

Utilizamos un tablero de estilo Kanban para priorizar el trabajo. Ir al tablero del proyecto.

Los principales canales de comunicación son github issues y el canal de Telegram. Siéntase libre mandar todas las preguntas que pueda tener.

Pautas para contribuyentes. https://developers.eoscostarica.io/docs/open-source-guidelines.

Informe cualquier idea o errores grandes y pequeños abriendo un "issue".

Editar Contenido

La documentación se genera a partir de archivos en formato markdown ubicados dentro de la sub-carpeta /docs. Ver mas información aquí.

Guía rápida

Estructura de archivos

es.latamlink.io
├── .github
│ ├── workflows
│ | ├── nodejs.yml
│ └─└── services
├── docs
├── src
│ ├── css
│ | ├── custom.css
│ | └── homepage.css
│ └── pages
│ 	├── styles.module.css
│   └── index.js
├── static
│ ├── img
│ ├── imgages
│ ├── scripts
│ ├── js
│ ├── other
│ ├── favicon.ico
│ └── CNAME
├── .gitignore
├── babel.config.js
├── docusaurus.config.js
├── sidebars.js
├── package.json
├── yarn.lock
└── README.md

Resumen de la estructura del proyecto

• /docs/ - Contiene los archivos de Markdown para los documentos. Personaliza el orden de la barra lateral de documentos en sidebars.js. Se pueden encontrar más detalles en la guía de documentos.
• /src/ - Archivos que no son de documentación como páginas o componentes personalizados de React. No tiene que colocar estrictamente sus archivos que no son de documentación aquí, pero colocarlos en un directorio centralizado facilita la especificación en caso de que necesite hacer algún tipo de procesamiento.
• /src/pages - Cualquier archivo dentro de este directorio se convertirá en una página de sitio web. Se pueden encontrar más detalles en la guía de páginas.
• /static/ - Directorio estático. Cualquier contenido dentro de aquí se copiará en la raíz del directorio de compilación final build.
• /docusaurus.config.js - El archivo de configuración para el sitio. Este es el equivalente de siteConfig.js en Docusaurus 1.
• /package.json - Un sitio web de Docusaurus es una aplicación de React. Puede instalar y usar cualquier paquete npm que desee en ellos.
• /sidebar.js - Utilizado por la documentación para especificar el orden de los documentos en la navegación lateral.

Antes de empezar

Es necesario contar con:

• git
• node.js

Instrucciones para ejecutar el proyecto de forma local en Windows 10

1. Clone el repositorio

$ git clone https://github.com/LatamLink/es.latamlink.io.git

2. Ubíquese al directorio apropiado

$ cd es.latamlink.io

3. Instale las dependencias:

$ yarn install 

4. Compile el proyecto:

$ yarn build 

5. Ejecute el servidor local:

$ yarn serve 

Publicar

es.latamlink.io esta alojado en GitHub y se publica mediante el siguientes comandos:

$ yarn build 

$ GIT_USER=LatamLink CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

Licencia

MIT © LatamLink Testnet