Bram

History

Adam Schmalhofer 4dbec88b7f Port banglerun to new typescript system		2022-01-18 14:49:28 +01:00
..
types	document typing progress	2021-12-10 23:17:18 +01:00
.gitignore	move package back within typescript	2021-12-10 20:52:17 +01:00
README.md	Update README.md	2021-12-10 22:02:41 +01:00
package-lock.json	fix global vars inside IDE (only cli to go)	2021-12-10 21:19:01 +01:00
package.json	make tsconfig work for all ts apps	2021-12-10 21:51:35 +01:00
tsconfig.json	Port banglerun to new typescript system	2022-01-18 14:49:28 +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

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.

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 folder. Then run:

npm ci

to install the project's build tools, and:

npm run build:apps

To build all Typescript apps. The last command will generate the app.js files containing the transpiled code for the BangleJS.