History

Sebastian Di Luzio 96b099b10a make tsconfig work for all ts apps		2021-12-10 21:51:35 +01:00
..
types	update TS rules to make them stricter	2021-12-10 21:36:42 +01:00
.gitignore	move package back within typescript	2021-12-10 20:52:17 +01:00
README.md	move package back within typescript	2021-12-10 20:52:17 +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	make tsconfig work for all ts apps	2021-12-10 21:51:35 +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 folder. Then run:

npm ci

to install the project's build tools, and:

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

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