From 39c3a11d9f65730baac527c5586799709aba9055 Mon Sep 17 00:00:00 2001
From: Sebastian Di Luzio <sebidiluzio@gmail.com>
Date: Tue, 7 Dec 2021 21:38:09 +0100
Subject: [PATCH] first draft: does not export to correct path yet

---
 typescript/sharedLib/.gitignore        |  2 ++
 typescript/sharedLib/README.md         | 27 +++++++++++++++++++
 typescript/sharedLib/package-lock.json | 37 ++++++++++++++++++++++++++
 typescript/sharedLib/package.json      | 20 ++++++++++++++
 typescript/sharedLib/src/app.ts        |  2 ++
 typescript/sharedLib/tsconfig.json     |  8 ++++++
 6 files changed, 96 insertions(+)
 create mode 100644 typescript/sharedLib/.gitignore
 create mode 100644 typescript/sharedLib/README.md
 create mode 100644 typescript/sharedLib/package-lock.json
 create mode 100644 typescript/sharedLib/package.json
 create mode 100644 typescript/sharedLib/src/app.ts
 create mode 100644 typescript/sharedLib/tsconfig.json

diff --git a/typescript/sharedLib/.gitignore b/typescript/sharedLib/.gitignore
new file mode 100644
index 000000000..b2af6e004
--- /dev/null
+++ b/typescript/sharedLib/.gitignore
@@ -0,0 +1,2 @@
+node_modules/
+!package-lock.json
\ No newline at end of file
diff --git a/typescript/sharedLib/README.md b/typescript/sharedLib/README.md
new file mode 100644
index 000000000..78b07b332
--- /dev/null
+++ b/typescript/sharedLib/README.md
@@ -0,0 +1,27 @@
+# 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](https://www.npmjs.com/get-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:
+
+```
+npm run build:app pathToYourApp.ts
+```
+
+To build your app. The last command will generate the `app.js` file containing the transpiled code for the BangleJS.
diff --git a/typescript/sharedLib/package-lock.json b/typescript/sharedLib/package-lock.json
new file mode 100644
index 000000000..9df411a91
--- /dev/null
+++ b/typescript/sharedLib/package-lock.json
@@ -0,0 +1,37 @@
+{
+  "name": "banglets",
+  "version": "0.1.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "banglets",
+      "version": "0.1.0",
+      "license": "MIT",
+      "devDependencies": {
+        "typescript": "^4.5.2"
+      }
+    },
+    "node_modules/typescript": {
+      "version": "4.5.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.2.tgz",
+      "integrity": "sha512-5BlMof9H1yGt0P8/WF+wPNw6GfctgGjXp5hkblpyT+8rkASSmkUKMXrxR0Xg8ThVCi/JnHQiKXeBaEwCeQwMFw==",
+      "dev": true,
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=4.2.0"
+      }
+    }
+  },
+  "dependencies": {
+    "typescript": {
+      "version": "4.5.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.2.tgz",
+      "integrity": "sha512-5BlMof9H1yGt0P8/WF+wPNw6GfctgGjXp5hkblpyT+8rkASSmkUKMXrxR0Xg8ThVCi/JnHQiKXeBaEwCeQwMFw==",
+      "dev": true
+    }
+  }
+}
diff --git a/typescript/sharedLib/package.json b/typescript/sharedLib/package.json
new file mode 100644
index 000000000..2bf45de2e
--- /dev/null
+++ b/typescript/sharedLib/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "bangle.ts",
+  "version": "0.1.0",
+  "description": "Typescript configuration and typings for Bangle.js",
+  "main": "app.js",
+  "types": "app.d.ts",
+  "scripts": {
+    "build:testapp": "tsc src/app.ts",
+    "build:types": "tsc src/bangle.d.ts",
+    "build:app": "tsc"
+  },
+  "author": {
+    "name": "Sebastian Di Luzio",
+    "email": "sebastian@diluz.io"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^4.5.2"
+  }
+}
diff --git a/typescript/sharedLib/src/app.ts b/typescript/sharedLib/src/app.ts
new file mode 100644
index 000000000..6e5739557
--- /dev/null
+++ b/typescript/sharedLib/src/app.ts
@@ -0,0 +1,2 @@
+const testString = 'test hehe';
+console.log(testString);
diff --git a/typescript/sharedLib/tsconfig.json b/typescript/sharedLib/tsconfig.json
new file mode 100644
index 000000000..42b34ec65
--- /dev/null
+++ b/typescript/sharedLib/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "es2015",
+    "noImplicitAny": true,
+    "target": "es2015",
+    "outDir": "../dist"
+  }
+}