Added runLocalDocs for templates

This commit is contained in:
Eric Allam
2023-02-14 16:37:19 +00:00
parent 9388b5bbed
commit 1f3eb459c4
4 changed files with 33 additions and 0 deletions
@@ -0,0 +1,4 @@
-- AlterTable
ALTER TABLE "Template" ADD COLUMN "runLocalDocs" TEXT NOT NULL DEFAULT 'Documentation
This template does not have any documentation yet.';
+1
View File
@@ -601,6 +601,7 @@ model Template {
imageUrl String
repositoryUrl String
markdownDocs String @default("Documentation\n\nThis template does not have any documentation yet.")
runLocalDocs String @default("Documentation\n\nThis template does not have any documentation yet.")
priority Int @default(0)
+1
View File
@@ -26,6 +26,7 @@ async function seed() {
services: [],
workflowIds: ["basic-starter"],
markdownDocs: await readTemplateDocsFile("basic-starter"),
runLocalDocs: await readTemplateDocsFile("basic-starter-local"),
};
const githubStarsToSlack = {
+27
View File
@@ -0,0 +1,27 @@
## Run locally
First, clone the repo and install dependencies:
```sh
git clone https://github.com/triggerdotdev/basic-starter.git
cd basic-starter
npm install
```
Then create a `.env` file with your development Trigger.dev API Key:
```sh
echo "TRIGGER_API_KEY=<APIKEY>" >> .env
```
And finally you are ready to run the process:
```sh
npm run dev
```
You should see a message like the following:
```
[trigger.dev] ✨ Connected and listening for events [basic-starter]
```