Referencia Typescript (opcional)
Pasos para comenzar a usar el SDK desde cero, en caso de tener un proyecto inicializado omita estos pasos y proceda a la instalación.
Levantar un proyecto base
Levantaremos un proyecto _Typescript _para dar ejemplo de como usar nuestro SDK, para ello necesitamos ejecutar los siguientes comandos:
- Inicializar un proyecto Node.
npm init -y
- Instalamos _Typescript _dentro de nuestro proyecto.
npm install --save-dev typescript
- Inicializar Typescript: Al momento de ejecutar este comando se creara dentro de la carpeta de nuestro proyecto un archivo llamado tsconfig.json.
npx tsc --init
- Crear una carpeta llamada src y dentro de estar carpeta crear un archivo index.ts que contenga un print para verificar su ejecución. Ejemplo:
console.log("Hello DEUNA");
- Configurar el tsconfig.json esto nos permitirá configurar el outDir que es la carpeta donde se compilara el proyecto, y el rootDir es donde estará alojado nuestro código fuente que configuramos en el paso anterior
Agregar las siguientes líneas:
{
"compilerOptions": {
"target": "es2016",
"module": "commonjs",
"outDir": "./dist", // add
"rootDir": "./src", // add
"noImplicitAny": true, // add
"strictNullChecks": true, // add
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"strict": true,
"skipLibCheck": true
}
}
- Configurar el package.json para poder compilar y ejecutar el proyecto de una forma rápida.
Agrega este _build _dentro del script:
"scripts": {
"build": "tsc --build tsconfig.json && node dist/index.js"
},
- Ejecutar el proyecto.
npm run build
Nota: Si la instalación fue exitosa se podrá visualizar en la terminal "Hola DEUNA".
Updated about 1 year ago