chore(contrib): update guide and starter code

Hans Tognon · Hans Tognon · commit 3d7bdc358995 · 2023-07-25T14:17:48.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -97,7 +97,10 @@ The [examples/jobs-starter](./examples/jobs-starter/) project defines simple job
    TRIGGER_API_URL=http://localhost:3030
    ```
 
-3. Run the app:
+   `TRIGGER_API_URL` is used to configure the URL for your Trigger.dev instance,
+   where the jobs will be registered.
+
+3. Run the `jobs-starter` app:
 
    ```
    pnpm dev
diff --git a/examples/jobs-starter/package.json b/examples/jobs-starter/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "jobs-starter",
+  "name": "@examples/jobs-starter",
   "version": "0.1.0",
   "private": true,
   "scripts": {
@@ -11,8 +11,8 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "@trigger.dev/nextjs": "^1.0.0-next.8",
-    "@trigger.dev/sdk": "^2.0.0-next.18",
+    "@trigger.dev/nextjs": "workspace:*",
+    "@trigger.dev/sdk": "workspace:*",
     "@types/node": "20.4.2",
     "@types/react": "^18.0.21",
     "@types/react-dom": "^18.0.6",
@@ -30,6 +30,7 @@
     "endpointId": "jobs-starter"
   },
   "devDependencies": {
-    "concurrently": "^8.2.0"
+    "concurrently": "^8.2.0",
+    "@trigger.dev/cli": "workspace:*"
   }
 }
diff --git a/examples/jobs-starter/tsconfig.json b/examples/jobs-starter/tsconfig.json
@@ -14,14 +14,18 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "incremental": true,
+    "paths": {
+      "@/*": ["./*"],
+      "@trigger.dev/sdk": ["../../packages/trigger-sdk/src/index"],
+      "@trigger.dev/sdk/*": ["../../packages/trigger-sdk/src/*"],
+      "@trigger.dev/nextjs": ["../../packages/nextjs/src/index"],
+      "@trigger.dev/nextjs/*": ["../../packages/nextjs/src/*"]
+    },
     "plugins": [
       {
         "name": "next"
       }
-    ],
-    "paths": {
-      "@/*": ["./*"]
-    }
+    ]
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
   "exclude": ["node_modules"]
