mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-23 01:54:18 -08:00
d90e028c1b
* First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation
58 lines
2.7 KiB
Markdown
58 lines
2.7 KiB
Markdown
# Instalación de la herramienta Justice40
|
|
|
|
*[Read this in English](INSTALLATION.md)*
|
|
|
|
## Software requerido
|
|
- git, node, and an IDE
|
|
|
|
### Instalar Git
|
|
|
|
#### MacOS
|
|
1. Abra la terminal, escriba `git` y presione RETORNO.
|
|
2. Si las herramientas de desarrollo no están instaladas, una ventana le pedirá que instale las herramientas de desarrollo.
|
|
3. Abrieron la terminal y escribieron `git --version` y presionaron RETORNO.
|
|
4. Valide que se devuelva un número de versión. Si es así, git está instalado correctamente.
|
|
|
|
#### Win10
|
|
Descargar desde [sitio web](https://git-scm.com/download/win)
|
|
|
|
|
|
### Instalar Homebrew (MacOS only)
|
|
1. Abra la terminal y copie / pegue este comando y presione RETORNO.
|
|
|
|
`/bin/bash -c “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"`
|
|
|
|
2. Valide la instalación escribiendo `brew -v` en la terminal y asegúrese de que se muestre un número de versión.
|
|
|
|
### Instalar Node usando NVM
|
|
|
|
Esto funcionará tanto para MacOS como para Win10. Siga las instrucciones de este [enlace](https://medium.com/@nodesource/installing-node-js-tutorial-using-nvm-5c6ff5925dd8)
|
|
|
|
### Configuración de IDE
|
|
Si bien se puede usar cualquier IDE, describimos cómo configurar VS Code
|
|
|
|
1. Abra la terminal y escriba `brew install --cask visual-studio-code` y presione RETORNO.
|
|
1. Si esto no funciona o para Win10, puede descargar VS Code desde el [sitio web](https://code.visualstudio.com/).
|
|
2. Después de [bifurcar este repositorio](https://github.com/usds/justice40-tool/blob/main/CONTRIBUTING-es.md#colaboraciones-con-c%C3%B3digo), puede clonar su repositorio bifurcado en VS Code
|
|
3. VS Code con el mensaje de "clonar un repositorio"
|
|
4. Abra la terminal y navegue al directorio `cliente`
|
|
5. Escriba `npm install` para cargar las dependencias
|
|
6. Escribe "gatsby development" para activar la aplicación.
|
|
7. Navegue a `localhost: 8000` para ver la aplicación
|
|
|
|
#### Extensiones de VS Code recomendadas
|
|
|
|
1. [Browser Preview](https://github.com/auchenberg/vscode-browser-preview)
|
|
2. [Live Server](https://github.com/ritwickdey/vscode-live-server)
|
|
3. [Live Share](https://github.com/MicrosoftDocs/live-share)
|
|
4. [Live Share Audio](https://github.com/MicrosoftDocs/live-share)
|
|
5. [Live Share Extention Pack](https://github.com/MicrosoftDocs/live-share)
|
|
|
|
## Ejecuta el código
|
|
|
|
1. Bifurcar este repositorio y crear un clon local. [Más información](https://docs.github.com/es/github/getting-started-with-github/quickstart/fork-a-repo)
|
|
1. Si está usando una Mac y Homebrew, abra la terminal y escriba `brew update` y `brew doctor`.
|
|
|
|
Para el desarrollo de front-end, lea el [Client README](client/README.md).
|
|
|
|
Para el desorrollo de back-end, lea el [Data Pipeline README](data/data-pipeline/README.md).
|