build: copied over configs

Author: tegefaulkes

.env.example

@@ -7,6 +7,16 @@ NODE_ENV=development
 # Debug node native modules - https://nodejs.org/api/cli.html#node_debug_nativemodule
 # NODE_DEBUG_NATIVE=
 
+# Path to PK executable to override tests/bin target
+# PK_TEST_COMMAND=
+
+# If set, indicates that `PK_TEST_COMMAND` is targetting docker
+# PK_TEST_COMMAND_DOCKER=
+# Accessing AWS for testnet.polykey.io and mainnet.polykey.io deployment
+AWS_DEFAULT_REGION='ap-southeast-2'
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+
 # Path to container registry authentication file used by `skopeo`
 # The file has the same contents as `DOCKER_AUTH_CONFIG`
 # Use this command to acquire the auth file at `./tmp/auth.json`:
@@ -18,3 +28,13 @@ NODE_ENV=development
 #   --authfile=./tmp/auth.json
 # ```
 # REGISTRY_AUTH_FILE=
+
+# Authenticate to GitHub with `gh`
+# GITHUB_TOKEN=
+
+# To allow testing different executables in the bin tests
+# Both PK_TEST_COMMAND and PK_TEST_PLATFORM must be set at the same time
+# PK_TEST_COMMAND= #Specify the shell command we want to test against
+# PK_TEST_PLATFORM=docker #Overrides the auto set `testPlatform` variable used for enabling platform specific tests
+# PK_TEST_TMPDIR= #Sets the `global.tmpDir` variable to allow overriding the temp directory used for tests
+

.eslintignore

@@ -0,0 +1 @@
+src/proto/*

.eslintrc

@@ -10,8 +10,7 @@
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "prettier"
+    "plugin:prettier/recommended"
   ],
   "plugins": [
     "import"

.gitignore

@@ -126,3 +126,7 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# editor
+.vscode/
+.idea/

.npmignore

@@ -3,7 +3,9 @@
 /nix
 /tsconfig.json
 /tsconfig.build.json
+/babel.config.js
 /jest.config.js
+/nodemon.json
 /scripts
 /src
 /tests

README.md

@@ -1,5 +1,41 @@
 # Polykey-CLI
 
+staging:[![pipeline status](https://gitlab.com/MatrixAI/open-source/Polykey-CLI/badges/staging/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/Polykey-CLI/commits/staging)
+master:[![pipeline status](https://gitlab.com/MatrixAI/open-source/Polykey-CLI/badges/master/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/Polykey-CLI/commits/master)
+
+Polykey is an open-source decentralized secrets management and sharing system. It is made for today's decentralized world of people, services and devices.
+
+* Decentralized Encrypted Storage - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes.
+* Secure Peer-to-Peer Communications - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub).
+* Secure Computational Workflows - Share secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure.
+
+<p align="center">
+  <img src="./images/cli_demo.gif" alt="Polykey CLI Demo"/>
+</p>
+
+Polykey synthesizes a unified workflow between interactive password management and infrastructure key management.
+
+You have complete end-to-end control and privacy over your secrets, with no third-party data collection.
+
+Polykey runs on distributed keynodes referred to as "nodes". Any computing system can run multiple keynodes. Each node manages one or more vaults which are encrypted filesystems with automatic version history. Vaults can be shared between the nodes.
+
+This repository is the core library for Polykey.
+
+The Polykey project is split up into these main repositories:
+
+* [Polykey](https://github.com/MatrixAI/Polykey) - Polykey Core Library
+* [Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI) - CLI of Polykey
+* [Polykey-Desktop](https://github.com/MatrixAI/Polykey-Desktop) - Polykey Desktop (Windows, Mac, Linux) application
+* [Polykey-Mobile](https://github.com/MatrixAI/Polykey-Mobile) - Polykey Mobile (iOS & Android) Application
+
+Have a bug or a feature-request? Please submit it the issues of the relevant subproject above.
+
+For tutorials, how-to guides, reference and theory, see the [docs](https://polykey.io/docs).
+
+Have a question? Join our [discussion board](https://github.com/MatrixAI/Polykey/discussions).
+
+Our main website is https://polykey.io
+
 ## Installation
 
 Note that JavaScript libraries are not packaged in Nix. Only JavaScript applications are.

images/cli_demo.gif

@@ -49,15 +49,15 @@ module.exports = {
     "^.+\\.(t|j)sx?$": [
       "@swc/jest",
       {
-        jsc: {
-          parser: {
-            syntax: "typescript",
-            tsx: true,
-            decorators: compilerOptions.experimentalDecorators,
-            dynamicImport: true,
+        "jsc": {
+          "parser": {
+            "syntax": "typescript",
+            "dynamicImport": true,
+            "tsx": true,
+            "decorators": compilerOptions.experimentalDecorators,
           },
-          target: compilerOptions.target.toLowerCase(),
-          keepClassNames: true,
+          "target": compilerOptions.target.toLowerCase(),
+          "keepClassNames": true,
         },
       }
     ],

jest.config.js

@@ -11,7 +11,6 @@ in
       gitAndTools.gh
       skopeo
       jq
-      jetbrains.webstorm
     ];
     PKG_CACHE_PATH = utils.pkgCachePath;
     PKG_IGNORE_TAG = 1;