2021-12-07 20:38:09 +00:00
# BangleTS
A generic project setup for compiling apps from Typescript to Bangle.js ready, readable Javascript.
2021-12-07 20:46:28 +00:00
It includes types for _some_ of the modules and globals that are exposed for apps to use.
2021-12-07 20:38:09 +00:00
The goal is to have types for everything, but that will take some time. Feel free to help out by contributing!
## Using the types
2021-12-07 20:46:28 +00:00
2021-12-10 21:02:41 +00:00
All currently typed modules can be found in `/typescript/types.globals.d.ts` .
The typing is an ongoing process. If anything is still missing, you can add it! It will automatically be available in your TS files.
2021-12-07 20:38:09 +00:00
## Compilation
2022-01-20 20:09:57 +00:00
Install [npm ](https://www.npmjs.com/get-npm ) and node.js if you haven't already. We recommend using a version manager like nvm, which is also referenced in the linked documentation.
Make sure you are using node version 16 by running `nvm use 16` and npm version ^8 by running `npm -v` . If the latter version is incorrect, run `npm i -g npm@^8` .
2021-12-07 20:38:09 +00:00
2021-12-10 19:52:17 +00:00
After having installed npm for your platform, open a terminal, and navigate into the `/typescript` folder. Then run:
2021-12-07 20:38:09 +00:00
```
npm ci
```
to install the project's build tools, and:
```
2022-01-20 20:09:57 +00:00
npm run build
2021-12-07 20:38:09 +00:00
```
2022-01-20 20:09:57 +00:00
To build all Typescript apps and widgets. The last command will generate the `app.js` files containing the transpiled code for the BangleJS.
