Bram

History

Sebastian Di Luzio 63b26f5d1f move dev dependencies to main package.json, get first compiling version of test widget - i still want to be able to get the types ambiently defined without any weird import needed - it would be nice to be able to have a separate package.json in ./typescirpt. not sure if it's possible, I would move working on that part to the end		2021-12-08 20:22:39 +01:00
..
types	move dev dependencies to main package.json, get first compiling version of test widget	2021-12-08 20:22:39 +01:00
README.md	prepare for using with widChargingStatus	2021-12-07 22:27:09 +01:00

README.md

BangleTS

A generic project setup for compiling apps from Typescript to Bangle.js ready, readable Javascript. It includes types for some of the modules and globals that are exposed for apps to use. The goal is to have types for everything, but that will take some time. Feel free to help out by contributing!

Using the types

TODO

Compilation

Install npm if you haven't already. Make sure you are using version ^8 by running npm -v. If the version is incorrect, run npm i -g npm@^8.

After having installed npm for your platform, open a terminal, and navigate into the /typescript/sharedLib folder. Then run:

npm ci

to install the project's build tools, and:

npx tsc ./relativePathToYourApp/app.ts --outDir ./relativePathToYourApp/dist

To build your app. The last command will generate the app.js file containing the transpiled code for the BangleJS.