Monorepo Time

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+      day: 'saturday'
+    versioning-strategy: 'increase'
+    labels:
+      - 'dependencies'
+    open-pull-requests-limit: 5
+    pull-request-branch-name:
+      separator: '-'
+    commit-message:
+      # cause a release for non-dev-deps
+      prefix: fix(deps)
+      # no release for dev-deps
+      prefix-development: chore(dev-deps)
+    ignore:
+      - dependency-name: '@salesforce/dev-scripts'
+      - dependency-name: '*'
+        update-types: ['version-update:semver-major']

.github/workflows/automerge.yml

@@ -0,0 +1,10 @@
+name: automerge
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '17 2,5,8,11 * * *'
+
+jobs:
+  automerge:
+    uses: oclif/github-workflows/.github/workflows/automerge.yml@main
+    secrets: inherit

.github/workflows/failureNotifications.yml

@@ -0,0 +1,43 @@
+name: failureNotifications
+
+on:
+  workflow_run:
+    workflows:
+      - version, tag and github release
+      - publish
+    types:
+      - completed
+
+jobs:
+  failure-notify:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - name: Announce Failure
+        id: slack
+        uses: slackapi/[email protected]
+        env:
+          # for non-CLI-team-owned plugins, you can send this anywhere you like
+          SLACK_WEBHOOK_URL: ${{ secrets.CLI_ALERTS_SLACK_WEBHOOK }}
+          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
+        with:
+          payload: |
+            {
+              "text": "${{ github.event.workflow_run.name }} failed: ${{ github.event.workflow_run.repository.name }}",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": ":bh-alert: ${{ github.event.workflow_run.name }} failed: ${{ github.event.workflow_run.repository.name }} :bh-alert:"
+                  }
+                },
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "Repo: ${{ github.event.workflow_run.repository.html_url }}\nWorkflow name: `${{ github.event.workflow_run.name }}`\nJob url: ${{ github.event.workflow_run.html_url }}"
+                  }
+                }
+              ]
+            }

.github/workflows/manualRelease.yml

@@ -0,0 +1,40 @@
+name: manual release
+
+on:
+  workflow_dispatch:
+
+defaults:
+  run:
+    working-directory: packages/cli
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }}
+      - name: Conventional Changelog Action
+        id: changelog
+        uses: TriPSs/conventional-changelog-action@d360fad3a42feca6462f72c97c165d60a02d4bf2
+        # overriding some of the basic behaviors to just get the changelog
+        with:
+          git-user-name: svc-cli-bot
+          git-user-email: [email protected]
+          github-token: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }}
+          output-file: false
+          # always do the release, even if there are no semantic commits
+          skip-on-empty: false
+          tag-prefix: ''
+      - uses: notiz-dev/github-action-json-property@2192e246737701f108a4571462b76c75e7376216
+        id: packageVersion
+        with:
+          path: 'packages/cli/package.json'
+          prop_path: 'version'
+      - name: Create Github Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.packageVersion.outputs.prop }}
+          release_name: ${{ steps.packageVersion.outputs.prop }}

.github/workflows/onPushToMain.yml

@@ -0,0 +1,27 @@
+# test
+name: version, tag and github release
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'packages/cli/**'
+      - '.github/workflows/**'
+
+defaults:
+  run:
+    working-directory: packages/cli
+
+jobs:
+  release:
+    uses: oclif/github-workflows/.github/workflows/githubRelease.yml@main
+    with:
+      working-directory: packages/cli
+    secrets: inherit
+
+  # most repos won't use this
+  # depends on previous job to avoid git collisions, not for any functionality reason
+  # docs:
+  #   uses: salesforcecli/github-workflows/.github/workflows/publishTypedoc.yml@main
+  #   secrets: inherit
+  #   needs: release

.github/workflows/onRelease.yml

@@ -0,0 +1,25 @@
+name: publish
+
+on:
+  release:
+    types: [released]
+  # support manual release in case something goes wrong and needs to be repeated or tested
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: tag that needs to publish
+        type: string
+        required: true
+
+defaults:
+  run:
+    working-directory: packages/cli
+
+jobs:
+  npm:
+    uses: oclif/github-workflows/.github/workflows/npmPublish.yml@main
+    with:
+      tag: latest
+      githubTag: ${{ github.event.release.tag_name || inputs.tag }}
+      working-directory: packages/cli
+    secrets: inherit

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: tests
+on:
+  push:
+    branches-ignore: [main]
+    paths:
+      - 'packages/cli/**'
+      - '.github/workflows/**'
+  workflow_dispatch:
+
+defaults:
+  run:
+    working-directory: packages/cli
+
+jobs:
+  unit-tests:
+    uses: oclif/github-workflows/.github/workflows/unitTest.yml@main
+    with:
+      working-directory: packages/cli

README.md

@@ -1,128 +1,109 @@
-<a href="https://directus.io" target="_blank">
+# Starter Templates with Directus Integration
 
-  <h1 align="center">Directus Templates</h1>
-</a>
+This repo provides a collection of starter templates for building web applications with Directus integration. Initially, this includes a **Simple CMS**, but upcoming templates will also include **Simple CRM** and **Simple eCommerce** solutions.
 
-<p align="center">Community maintained Directus instance templates to help you jump start your next project. Apply and extract templates with <a href="https://github.com/directus-community/directus-template-cli"target="_blank">directus-template-cli</a>.
-</p>
+Each template is designed to be:
 
-<p align="center">
-  <a href="#introduction"><strong>Introduction</strong></a> ·
-  <a href="#using-templates"><strong>🚧 Using Templates</strong></a> ·
-  <a href="#%EF%B8%8F-contributing"><strong>❤️ Contributing</strong></a>
-</p>
-<br/>
-<br />
+- **Reusable**: Modular codebases that can be easily extended.
+- **Framework-Specific**: Tailored implementations for popular frameworks like Next.js, Nuxt.js, Svelte, and Astro.
+- **Scalable**: Suitable for small to medium projects and scalable to larger applications.
 
-# 🚀 Introduction
-
-## What is a Directus "Template"?
-A Directus template is a starter kit or boilerplate for a Directus project. But it could be a full blown application – like [AgencyOS](https://github.com/directus-community/agency-os).
-
-Templates are extracted and applied using the [`directus-template-cli`](https://github.com/directus-community/directus-template-cli) command line utility.
-
-- They're examples of what you can build with Directus
-- They're starting points for your next client project
-- They're going to save you a boatload of time
-
-## What's Included in a Template?
-
-**Schema / Data Model**
-- Schema Snapshot
-- Collections
-- Fields
-- Relations
-
-**Users and Authentication**
-- Users
-- Roles
-- Permissions
-- Presets
-
-**Flows**
-- Flows
-- Operations
-
-**Dashboards**
-- Dashboards
-- Panels
+---
 
-**Assets**
-- Folders
-- Files
-- Actual Files for Assets
+## **Current and Upcoming Templates**
 
-**Sample Content / Data**
-- Translations
-- Content
+| Template             | Status         | Description                                  |
+| -------------------- | -------------- | -------------------------------------------- |
+| **Simple CMS**       | 🚧 In Progress | A starter CMS template for managing content. |
+| **Simple CRM**       | 🕒 Upcoming    | A CRM template for managing customer data.   |
+| **Simple eCommerce** | 🕒 Upcoming    | A template for building eCommerce solutions. |
 
 ---
 
+## **Getting Started**
 
-# **🚧 Using Templates**
+### **Using Directus with a Cloud Instance (Recommended)**
 
-To load or use templates you need a Directus instance. Here's a few ways to go about that.
+1. **Create a New Project**:
 
-### 1a - Register for a Directus Cloud account
+   - Visit [Directus Cloud](https://directus.io/cloud/) and create a new project.
+   - During the setup process, be sure to select the appropriate template for your project (**Simple CMS**, **Simple CRM**, or **Simple eCommerce**).
+   - Once started, it will take around 90 seconds for the Cloud Project to be created.
+   - You will receive an email with your project URL, email, and password for logging in.
+   - If you used GitHub to create your account, this will be your GitHub email.
 
-https://directus.cloud/register
+2. **Access Your New Project**:
 
-This is the easy button. You don’t have to mess with Docker or working out how to deploy a Directus instance at AWS,
-Digital Ocean, or similar hosts. A couple of clicks and in less than 2 minutes you’ll have a ready to go Directus
-project.
+   - Log in to your project using the URL provided in your email or from the Directus Cloud Dashboard.
 
-OR
+3. **Select a Template**:
+   - Navigate to the folder for the framework you want to use in this repo.
+   - Follow the instructions in that template's README to set up your application and connect it to your cloud instance.
 
-### 1b - Self Host a Directus Instance
+---
 
-If you're prefer to self-host Directus, we highly recommend you do so with Docker. We have several guides on the [Directus docs](https://docs.directus.io/self-hosted/docker-guide.html).
+### **Using Directus Locally**
 
-**Important Note**: We (the Directus team) cannot provide support for
-self-hosted instances WITHOUT an Enterprise Self-Hosted license or formal support agreement.
-[Learn more and contact our team for details on Enterprise Self-Hosted](https://directus.io/pricing/self-hosted).
+For local development, follow these steps:
 
+1. **Install Docker**:
 
-[PostgreSQL](https://www.postgresql.org/) is the **tested and preferred** database vendor for templates.
+   - Ensure Docker is installed and running on your machine: [Download Docker](https://www.docker.com/products/docker-desktop).
 
+2. **Clone the Template You Want**:
 
-### 2 **- Generate a static token for the admin user**
+   - Select the template folder for your chosen framework (e.g., `simple-cms`) and clone it:
+     ```bash
+     git clone https://github.com/your-org/starters.git simple-cms
+     cd simple-cms
+     ```
 
-You need the static token to seed the project.
+3. **Navigate to the `directus/` Folder**:
 
-1. Go to the User Directory
-2. Choose the Administrative User
-3. Scroll down to the Token field
-4. Generate token and copy it
-5. Save the user (do NOT forget to save because you’ll get an error that shows Invalid token!)
+   - Inside your cloned template folder, navigate to the `directus/` folder:
+     ```bash
+     cd directus
+     ```
 
-### 3 **- Apply the Template**
+4. **Start Directus**:
 
-Open your terminal, run the following command, and simply follow the prompts.
+   - Run Docker Compose to start the Directus instance:
 
-`npx directus-template-cli@latest apply`
+     ```bash
+     docker-compose up -d
+     ```
 
-You can load apply templates from three sources.
+   - This will start Directus on [http://localhost:8055](http://localhost:8055). Use the following credentials to log in:
+     - **Admin Email**: `[email protected]`
+     - **Admin Password**: `d1r3ctu5`
 
-- Official Templates (maintained in this repo)
-- Local directory (files on your local computer)
-- GitHub repository (public only)
+5. **Apply a Template**:
 
-You can learn more about the
-[Directus Template CLI tool here](https://github.com/directus-community/directus-template-cli).
+   - Use the [Directus Template CLI](https://github.com/directus-labs/directus-template-cli) to apply a pre-configured template for your project. Follow these steps:
 
-_Note_: It can take a
-few minutes for the template script to run if you’re using a remotely hosted Directus instance.
+     1. \*\*Generate a static token for the admin user:
 
-# ❤️ Contributing
+        - Go to the **Users Directory**
+        - Choose the Administrative User
+        - Scroll down to the **Token** field and generate a static token.
+        - Copy the token and save it. **Do not forget to save the user**, or you will encounter an "Invalid token" error.
 
-This is community driven project so we'd love to have your contributions.
+     2. **Run the Template CLI Tool**:
 
-You can extract your own templates using:
+        - Open your terminal, run the following command, and follow the prompts:
+          ```bash
+          npx directus-template-cli@latest apply
+          ```
 
-`npx directus-template-cli@latest extract`
+     3. **Follow the Prompts**:
 
-Here's how you can contribute:
-- [Make a pull request](https://github.com/directus-community/directus-templates/pulls) to add your own template.
+        - Choose `Community templates`
+        - Select the template from the list to apply (**Simple Website CMS**, **Simple CRM**, or **Simple eCommerce**)
+        - Fill in your Directus URL
+          ```bash
+          http://localhost:8055
+          ```
+        - Select `Directus Access Token`
+        - Fill in the token you saved from Step 1
 
-## 🙏 Thanks To
-Big shout out to [Alex van der Valk (AVDV)](https://github.com/alexvdvalk) for his contributions to this project.
+---

package.json

@@ -0,0 +1,6 @@
+{
+    "name": "@directus-labs/templates",
+    "private": true,
+    "scripts": {},
+    "license": "MIT"
+}