# vulkan-js

> UONET+ Vulkan Mobile API Wrapper in TypeScript

Latest version **0.1.1** (published 2020-02-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install vulkan-js
pnpm add vulkan-js
yarn add vulkan-js
bun add vulkan-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-02-16 |
| First published | 2020-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 32.6 KB |
| Known vulnerabilities | 0 (+41 in 2 direct dependencies) |
| Install scripts | no |
| Author | neoney |
| Maintainers | neoney |

## Links

- npm: https://www.npmjs.com/package/vulkan-js
- npm.io page: https://npm.io/package/vulkan-js

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.19.2
- [uuidv4](https://npm.io/package/uuidv4.md) ^6.0.2
- [node-forge](https://npm.io/package/node-forge.md) ^0.9.1
- [@wulkanowy/uonet-request-signer-node](https://npm.io/package/@wulkanowy/uonet-request-signer-node.md) ^0.1.1

## Recent versions

- 0.1.1 (latest) — 2020-02-16
- 0.1.0 — 2020-02-16

## README

# vulkan-js
##### A library for working with Vulkan's UONET+ school register.

### Instalation
```
npm install vulkan-js
```
or
```
yarn add vulkan-js
```

### Usage

Import the package 
```typescript
import Vulkan from "vulkan-js";
```
Initialize a new instance of the client
```typescript
const client = new Vulkan();
```
Register a new device on UONET+
```typescript
client.getCertificate(token, pin, symbol, deviceName, androidVersion).then(certificate => {
    // save the certificate to somewhere, in this case I'm saving it to a json file
    fs.writeFileSync("./config.json", JSON.stringify(certificate), "utf8");
});
```
Get the students of the account and start the app
```typescript
client.getStudents(certificate).then(students => {
    client.startApp(certificate, students);
});
```
After that you can explore the source or TypeScript IntelliSense and use the rest of the features (more will be implemented).

---
_Source: https://npm.io/package/vulkan-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._