Skip to content

Commit

Permalink
docs: add more doc and updat pkgs
Browse files Browse the repository at this point in the history
  • Loading branch information
leifermendez committed Oct 27, 2023
1 parent bbd744b commit 644ab33
Show file tree
Hide file tree
Showing 93 changed files with 1,868 additions and 645 deletions.
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,35 +21,34 @@ El lenguaje principal que se utilizó para desarrollar este proyecto fue __JavaS


__Requerimientos:__
- Node v16 o superior __[descargar node](https://nodejs.org/es/download/)__
- __[Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)__ como gestor de paquetes. En el link conseguirás las intrucciones para instalar yarn.
- Node v18 o superior __[descargar node](https://nodejs.org/es/download/)__
- __[pnpm](https://pnpm.io/cli/install)__ como gestor de paquetes. En el link conseguirás las intrucciones para instalar `pnmp`.
- __[VSCode](https://code.visualstudio.com/download)__ (recomendado): Editor de código con plugins.
- __[Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits&ssr=false#overview)__ (plugin-vscode) este plugin te ayudará a crear commit semántico.
- Se usará la rama __dev__ *(https://github.com/leifermendez/bot-whatsapp/tree/dev)* como rama principal hasta que se haga oficialmente el lanzamiento de la V2.

### 🚀 Iniciando

__Clonar repo rama dev__
__Clona repositorio (desde tu fork)__
```
git clone --branch dev https://github.com/codigoencasa/bot-whatsapp
git clone https://github.com/codigoencasa/bot-whatsapp
```
__Instalar dependencias__
```
cd bot-whatsapp
yarn install
pnpm install
```

__Compilar (build)__
Para compilar la aplicación es necesario ejecutar este comando, el cual genera un directorio `lib` dentro de los paquetes del monorepo.

```
yarn build
pnpm run build
```

__Example-app__
Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un app-bot de ejemplo.
```
yarn run cli
pnpm run cli
```

Selecionas (mediante las flechas arriba y abajo) el proveedor que quieras usar y cuando estes sobre el presiona la barra de espacio, igualmente selecciona la base de datos que quieras usar.
Expand Down
32 changes: 16 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,32 +56,32 @@
"repository": "https://github.com/leifermendez/bot-whatsapp",
"license": "ISC",
"devDependencies": {
"@commitlint/cli": "^17.4.4",
"@rollup/plugin-strip": "^3.0.2",
"@commitlint/config-conventional": "^17.4.4",
"@octokit/core": "^4.2.0",
"@commitlint/cli": "^17.8.1",
"@commitlint/config-conventional": "^17.8.1",
"@octokit/core": "^4.2.4",
"@rollup/plugin-commonjs": "^23.0.7",
"@rollup/plugin-json": "^5.0.2",
"@rollup/plugin-node-resolve": "^15.0.1",
"@rollup/plugin-replace": "^5.0.2",
"c8": "^7.13.0",
"@rollup/plugin-node-resolve": "^15.2.3",
"@rollup/plugin-replace": "^5.0.4",
"@rollup/plugin-strip": "^3.0.4",
"c8": "^7.14.0",
"conventional-changelog": "^3.1.25",
"cross-env": "^7.0.3",
"eslint": "^8.34.0",
"eslint-config-prettier": "^8.6.0",
"fs-extra": "^11.1.0",
"eslint": "^8.52.0",
"eslint-config-prettier": "^8.10.0",
"fs-extra": "^11.1.1",
"git-cz": "^4.9.0",
"husky": "^8.0.3",
"mime-types": "^2.1.35",
"only-allow": "^1.1.1",
"prettier": "^2.8.4",
"only-allow": "^1.2.1",
"prettier": "^2.8.8",
"pretty-quick": "^3.1.3",
"prompts": "^2.4.2",
"rimraf": "^4.1.2",
"rollup": "^3.17.2",
"rimraf": "^4.4.1",
"rollup": "^3.29.4",
"rollup-plugin-cleanup": "^3.2.1",
"rollup-plugin-copy": "^3.4.0",
"semver": "^7.3.8",
"rollup-plugin-copy": "^3.5.0",
"semver": "^7.5.4",
"standard-version": "^9.5.0",
"uvu": "^0.5.6"
},
Expand Down
Loading

0 comments on commit 644ab33

Please sign in to comment.