History

Sebastian Di Luzio 3cd9c39525 add build example to export to correct path		2021-12-07 21:46:28 +01:00
..
src	first draft: does not export to correct path yet	2021-12-07 21:38:09 +01:00
.gitignore	first draft: does not export to correct path yet	2021-12-07 21:38:09 +01:00
README.md	add build example to export to correct path	2021-12-07 21:46:28 +01:00
package-lock.json	first draft: does not export to correct path yet	2021-12-07 21:38:09 +01:00
package.json	add build example to export to correct path	2021-12-07 21:46:28 +01:00
tsconfig.json	first draft: does not export to correct path yet	2021-12-07 21:38: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.