[Github Issue #554] improve dx (#555)

* [gh-#554] add nvmrc

* see https://github.com/nvm-sh/nvm

* [gh-#554] add watch commands and allow them to run concurrently

* [gh-#554] remove git add -A command as part of the husky pre-commit

* [gh-#554]  add yaml validation github action check

* [gh-#554]  fix providers yaml spacing

* [gh-#554] remove check-keys check

* See adrienverge/yamllint#540

* [gh-#554] remove dupe call

* [gh-#554] add tsx to lint and add fix command

* [gh-#554] use .env.example and add .env to source control

.env.example

@@ -0,0 +1,54 @@
+###############################################################################
+#
+# Configuration
+#
+# - Secure requests to with an API. Used to secure endpoints related to provider configs and credentials. 
+#
+# NANGO_SECRET_KEY=<PICK-A-SECRET-KEY>
+#
+# - To enable database credentials encryption, uncomment with a base64-encoded 256-bit key (warning: you cannot change this key once set).
+#
+# NANGO_ENCRYPTION_KEY=<ADD-BASE64-256BIT-KEY>
+#
+# - Customize database to store provider configurations and credentials.
+#   (running 'docker compose up' creates a local Postgres database with the following credentials)
+#
+# NANGO_DB_USER=<PICK-A-USERNAME>
+# NANGO_DB_PASSWORD=<PICK-A-PASSWORD>
+# NANGO_DB_HOST=<PICK-A-HOST>
+# NANGO_DB_PORT=<PICK-A-PORT>
+# NANGO_DB_NAME=<PICK-A-DB-NAME>
+# NANGO_DB_SSL=<PICK-TRUE-OR-FALSE>
+#
+#
+# - Configure server port (current value is the default for running Nango locally).
+#
+SERVER_PORT=3003
+#
+#
+# - Configure server full URL (current value is the default for running Nango locally).
+#
+NANGO_SERVER_URL=http://localhost:3003
+#
+#
+# - Configure a custom callback URL (by default it is NANGO_SERVER_URL/oauth/callback).
+#
+# NANGO_CALLBACK_URL=<CUSTOM-CALLBACK-URL>
+#
+#
+# - Configure the username and password for securing Nango's dashboard.
+#
+# NANGO_DASHBOARD_USERNAME=<PICK-A-USERNAME>
+# NANGO_DASHBOARD_PASSWORD=<PICK-A-PASSWORD>
+#
+#
+# - Set the log level (debug: most verbose, info: recommended for production, error: least verbose)
+#
+LOG_LEVEL=info
+#
+#
+# - Telemetry is minimal, anonymous and helps us improve (set to false to disable).
+#
+# TELEMETRY=false
+#
+###############################################################################

.github/workflows/validation.yaml

@@ -0,0 +1,17 @@
+name: Yaml Validation
+
+on: [push]
+
+concurrency:
+  group: validation-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  validation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Lint yaml files
+        uses: ibiqlik/action-yamllint@v3

.gitignore

@@ -3,3 +3,4 @@ node_modules/*
 logs/*
 nango-data/*
 .idea/*
+.env

.husky/pre-commit

@@ -2,4 +2,3 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm run prettier-format
-git add -A .

.nvmrc

@@ -0,0 +1 @@
+18

.yamllint

@@ -0,0 +1,9 @@
+extends: default
+
+rules:
+  line-length:
+    max: 200
+    level: warning
+  document-start: disable
+  truthy:
+    check-keys: false