Skip to content

Commit af6d2e3

Browse files
committed
docs: update README with a quickstart guide
1 parent 20fb0e0 commit af6d2e3

File tree

1 file changed

+15
-21
lines changed

1 file changed

+15
-21
lines changed

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,31 @@ Ser la referencia en Ecuador para conectar, fortalecer y ampliar el impacto de l
1616

1717
## ¿Cómo contribuir en este repositorio?
1818

19-
Este repositorio tiene instalado:
19+
### Guía de Inicio Rápido
2020

21-
- Un linter, `biome`
21+
En el directorio raíz de este repositorio, ejecuta:
2222

23-
Además de usar `pnpm` cómo administrador de paquetes para JS y amigos.
24-
25-
### Biome
26-
27-
`biome` es una alternativa a ESLint + Prettier, que está escrita en Rust. Es una excelente herramienta, que acorta considerablemente el tiempo de desarrollo. Aunque esta herramienta tiene un [paquete distribuído a través de `npm`](https://www.npmjs.com/package/@biomejs/biome), la invocación a través de `npm` / `pnpm` es un cuello de botella para su rendimiento.
28-
29-
### Instalación
23+
```
24+
pnpm install
25+
```
3026

31-
#### pnpm
27+
Para descargar las depedencias.
3228

33-
Preferimos una instalación global usando `pnpm`
29+
Cuando quieras revisar tus cambios, ejecuta:
3430

35-
```sh
36-
pnpm install --global @biomejs/biome dprint
31+
```
32+
pnpm dev
3733
```
3834

39-
Sin embargo, tanto `biome` como `dprint` están declarados cómo dependencias de desarrollo dentro del `package.json`.
40-
41-
>[Estamos a la mitad de una implementación de Nix, como administrador de paquete.](https://github.com/Ecuador-In-Tech/web/pull/20)
42-
43-
### Desarrollo
35+
Y abre, en tu navegador, `localhost:4321`. ¡Podrás observar nuestra página web!
4436

45-
La tubería UNIX intencionada para el desarrollo de este proyecto es:
37+
Es recomendable hacer una revisión más exhaustiva, por favor, procura ejecutar:
4638

47-
```sh
48-
pnpm check && pnpm dev
4939
```
40+
pnpm check && pnpm build && pnpm preview
41+
```
42+
43+
Antes de enviar tus commits hacia el repositorio principal. Ejectura `pnpm check` es suficiente; pero recomendados realizar el proceso entero: ¡tu sabes cómo son estas máquinas!
5044

5145
>Se está ponderando qué task runner se implementará para mejorar la experiencia de desarrollo
5246

0 commit comments

Comments
 (0)