@nuxtus/nuxtus 1.3.1 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 Changelog
 
+# [1.4.0](https://github.com/nuxtus/nuxtus/compare/v1.3.1...v1.4.0) (2022-08-24)
+
+
+### Features
+
+* :sparkles: add liquid templates ([4564a69](https://github.com/nuxtus/nuxtus/commit/4564a6983b420353e16147d39b68d909734e8113))
+* :sparkles: docs removed in favor of website ([59611ef](https://github.com/nuxtus/nuxtus/commit/59611efdfff2595fefcb7da3f80cfea53678b282))
+* :sparkles: new default starting page ([07e8dee](https://github.com/nuxtus/nuxtus/commit/07e8dee1475248cc329571c2f32eb9ab5382c579))
+
 ## [1.3.1](https://github.com/nuxtus/nuxtus/compare/v1.3.0...v1.3.1) (2022-08-17)
 
 

package/TODO

@@ -1,38 +1,42 @@
 
 Todo:
-  ☐ Handle fetch failures
-  ✔ Update docs.vue to use nuxtus-cli instead @done(22-06-12 20:57)
-  ✔ Fix code for singleton page in .vue template @done(22-06-13 19:06)
-  ✔ Make a CLI for creating index/listing pages for Directus API @done(22-06-10 20:42)
-  ✔ Set up [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) @done(22-06-16 20:23)
-  ✔ Setup [semantic release](https://github.com/semantic-release/semantic-release) @done(22-07-11 15:57)
-  ✔ Add interactive/pretty CLI for create-app.js @done(22-06-16 20:23)
-  ✔ Query database use (via interactive shell) in create-app.js @done(22-06-21 20:26)
-  ✔ Check node version for compatibility in create-app.js @done(22-06-16 22:07)
   ☐ Look at https://renovatebot.com/
-  ✔ Documentation: https://docusaurus.io/ or https://vuepress.vuejs.org/ @done(22-08-11 16:24)
-  ✔ Create Directus flow via Directus API @done(22-07-04 17:46)
-  ☐ Add ability to automatically update .env for none SQLite databases
-  ☐ Can I HMR when adding new pages/routes? - https://github.com/nuxt/framework/issues/5766 - awaiting rc.7
-  ✔ Add all questions in create-app to start of process for better user flow @done(22-07-13 19:15)
-  ✔ Allow use of different ports/URLs for Directus and Nuxt (currently hard-coded) @done(22-07-13 20:42)
-  ✔ Add "types" to cli to update types from Directus when not using hook - use @directus/sdk for /oas now on all apps @done(22-07-18 17:01)
   ☐ Make opening browser window on start optional using npm run start (not possible)
-  ✔ Look at moving login and server/api stuff to a Nuxt module @done(22-07-28 19:37)
-  ✔ Make sure separate packages can be used without Nuxt Boilerplate if required @done(22-07-28 19:37)
-  ✔ Console.log messages from directus extension should be formatted like other directus messages @done(22-07-19 20:46)
-  ✔ Add default Directus login to end of create-nuxtus script @done(22-07-19 17:30)
   ☐ When adding a new collection the new page triggers a nuxt restart then directus tries to send a field.create which fails. We get around this by getting the create field first but Directus still returns a 404 for the second request.
-  ✔ interfaces/nuxtus.ts should not be in .gitignore other than during my development (remove in create-nuxtus?) @done(22-07-11 12:52)
-  ✔ Add test coverage (done: generator, nuxtus-cli) @started(22-07-11 17:19) @done(22-07-14 08:03) @lasted(2d14h44m55s)
   ☐ GraphQL?
   ☐ Websockets (https://github.com/br41nslug/directus-websocket-subscribe)
-  ✔ Upgrade nuxt-directus @done(22-07-17 11:32)
   ☐ Add ability to use Directus static token instead of login (requires nuxt-directus v2.3.0) - UPDATE DOCS cli.md too!
   ☐ Get added to some nuxt/directus lists etc.
-  ☐ Directus and Nuxt project names in package.json based on project create name.
-  ☐ Add Directus and Nuxt URL to create-nuxtus script
-  ☐ Create a new package.json instead of using nuxtus one (remove all semantic release packages)
   ☐ Remove Google Fonts module (replace with fonts.bunny.net?)
-  ☐ Use directus install scripts (then copy hook) instead of npm install - this will sort out DB automatically!
   ☐ Nuxtus website should actually pull data from Directus!
+  ☐ Look into nx for running as monorepo instead of concurrent
+  ☐ Add Nuxtus logo to index.vue page
+
+Archive:
+  ✔ Handle fetch failures @done(22-08-18 18:06) @project(Todo)
+  ✔ Update docs.vue to use nuxtus-cli instead @done(22-06-12 20:57) @project(Todo)
+  ✔ Fix code for singleton page in .vue template @done(22-06-13 19:06) @project(Todo)
+  ✔ Make a CLI for creating index/listing pages for Directus API @done(22-06-10 20:42) @project(Todo)
+  ✔ Set up [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) @done(22-06-16 20:23) @project(Todo)
+  ✔ Setup [semantic release](https://github.com/semantic-release/semantic-release) @done(22-07-11 15:57) @project(Todo)
+  ✔ Add interactive/pretty CLI for create-app.js @done(22-06-16 20:23) @project(Todo)
+  ✔ Query database use (via interactive shell) in create-app.js @done(22-06-21 20:26) @project(Todo)
+  ✔ Check node version for compatibility in create-app.js @done(22-06-16 22:07) @project(Todo)
+  ✔ Documentation: https://docusaurus.io/ or https://vuepress.vuejs.org/ @done(22-08-11 16:24) @project(Todo)
+  ✔ Create Directus flow via Directus API @done(22-07-04 17:46) @project(Todo)
+  ✔ Add ability to automatically update .env for none SQLite databases @done(22-08-23 21:00) @project(Todo)
+  ✔ Can I HMR when adding new pages/routes? - https://github.com/nuxt/framework/issues/5766 - awaiting rc.7 @done(22-08-18 08:05) @project(Todo)
+  ✔ Add all questions in create-app to start of process for better user flow @done(22-07-13 19:15) @project(Todo)
+  ✔ Allow use of different ports/URLs for Directus and Nuxt (currently hard-coded) @done(22-07-13 20:42) @project(Todo)
+  ✔ Add "types" to cli to update types from Directus when not using hook - use @directus/sdk for /oas now on all apps @done(22-07-18 17:01) @project(Todo)
+  ✔ Look at moving login and server/api stuff to a Nuxt module @done(22-07-28 19:37) @project(Todo)
+  ✔ Make sure separate packages can be used without Nuxt Boilerplate if required @done(22-07-28 19:37) @project(Todo)
+  ✔ Console.log messages from directus extension should be formatted like other directus messages @done(22-07-19 20:46) @project(Todo)
+  ✔ Add default Directus login to end of create-nuxtus script @done(22-07-19 17:30) @project(Todo)
+  ✔ interfaces/nuxtus.ts should not be in .gitignore other than during my development (remove in create-nuxtus?) @done(22-07-11 12:52) @project(Todo)
+  ✔ Add test coverage (done: generator, nuxtus-cli) @started(22-07-11 17:19) @done(22-07-14 08:03) @lasted(2d14h44m55s) @project(Todo)
+  ✔ Upgrade nuxt-directus @done(22-07-17 11:32) @project(Todo)
+  ✔ Directus and Nuxt project names in package.json based on project create name. @done(22-08-21 20:38) @project(Todo)
+  ✔ Add Directus and Nuxt URL to create-nuxtus script @done(22-08-20 12:12) @project(Todo)
+  ✔ Create a new package.json instead of using nuxtus one (remove all semantic release packages) @done(22-08-23 21:00) @project(Todo)
+  ✔ Use directus install scripts (then copy hook) instead of npm install - this will sort out DB automatically! @done(22-08-18 18:07) @project(Todo)

package/client/nuxt.config.ts

@@ -17,12 +17,9 @@ export default defineNuxtConfig({
 			Inter: true,
 		},
 	},
-	build: {
-		transpile: ['@heroicons/vue']
-	},
 	tailwindcss: {
 		// Options
-		jit: true,
+		// jit: true,
 	},
 	directus: {},
 	nuxtus: {

package/client/package.json

@@ -14,8 +14,6 @@
     "nuxt": "^3.0.0-rc.8"
   },
   "dependencies": {
-    "@headlessui/vue": "^1.6.1",
-    "@heroicons/vue": "^1.0.6",
     "nuxt-directus": "^2.3.0"
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@nuxtus/nuxtus",
 	"description": "Directus/Nuxt boilerplate with Tailwind CSS.",
-	"version": "1.3.1",
+	"version": "1.4.0",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/nuxtus/nuxtus.git"
@@ -34,7 +34,7 @@
 		"@semantic-release/github": "^8.0.5",
 		"@semantic-release/release-notes-generator": "^10.0.3",
 		"concurrently": "^7.2.2",
-		"semantic-release": "^19.0.3"
+		"semantic-release": "^19.0.5"
 	},
 	"release": {
 		"branches": "main",

package/server/package.json

@@ -11,7 +11,6 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "directus": "^9.15.1",
-    "sqlite3": "^5.0.8"
+    "directus": "^9.15.1"
   }
 }

package/templates/env-stub.liquid

@@ -0,0 +1,326 @@
+####################################################################################################
+#
+# These values set environment variables which modify core settings of Directus.
+#
+# Values in square brackets are the default values.
+#
+# The following options are not all possible options. For more, see
+# https://docs.directus.io/self-hosted/config-options/
+#
+####################################################################################################
+####################################################################################################
+
+### General
+
+# IP or host the API listens on ["0.0.0.0"]
+HOST="0.0.0.0"
+
+# The port Directus will run on [8055]
+PORT=8055
+
+# The URL where your API can be reached on the web. It is also used for things like OAuth redirects,
+# forgot-password emails, and logos that needs to be publicly available on the internet. ["/"]
+PUBLIC_URL="/"
+# PUBLIC_URL="http://localhost:8055"
+
+# What level of detail to log. [info]
+# "fatal", "error", "warn", "info", "debug", "trace", "silent"
+# LOG_LEVEL="info"
+
+# Render the logs human readable (pretty) or as JSON (raw), [pretty]
+# "pretty", "raw"
+# LOG_STYLE="pretty"
+
+# Controls the maximum request body size. Accepts number of bytes, or human readable string ["100kb"]
+# MAX_PAYLOAD_SIZE="100kb"
+
+# Where to redirect to when navigating to /. Accepts a relative path, absolute URL, or false to disable ["./admin"]
+# ROOT_REDIRECT="./admin"
+
+# Whether or not to serve the Admin App under /admin. [true]
+# SERVE_APP=true
+
+# Whether or not to enable GraphQL Introspection [true]
+# GRAPHQL_INTROSPECTION=true
+
+####################################################################################################
+### Database
+
+# All DB_* environment variables are passed to the connection configuration of a Knex instance.
+# Based on your project's needs, you can extend the DB_* environment variables with any config
+# you need to pass to the database instance.
+
+{{ database }}
+
+
+# These match the databases defined in the docker-compose file in the root of this repo
+
+## Postgres
+# DB_CLIENT="pg"
+# DB_HOST="localhost"
+# DB_PORT=5432
+# DB_DATABASE="directus"
+# DB_USER="postgres"
+# DB_PASSWORD="secret"
+
+## CockroachDB
+# DB_CLIENT="cockroachdb"
+# DB_HOST="localhost"
+# DB_PORT=26257
+# DB_DATABASE="directus"
+# DB_USER="root"
+# DB_PASSWORD=""
+
+## MySQL 8
+# DB_CLIENT="mysql"
+# DB_HOST="localhost"
+# DB_PORT=3306
+# DB_DATABASE="directus"
+# DB_USER="root"
+# DB_PASSWORD="secret"
+
+## MariaDB
+# DB_CLIENT="mysql"
+# DB_HOST="localhost"
+# DB_PORT=3306
+# DB_DATABASE="directus"
+# DB_USER="root"
+# DB_PASSWORD="secret"
+
+## MS SQL
+# DB_CLIENT="mssql"
+# DB_HOST="localhost"
+# DB_PORT=1343
+# DB_DATABASE="directus"
+# DB_USER="sa"
+# DB_PASSWORD="Test@123"
+
+## OracleDB
+# DB_CLIENT="oracledb"
+# DB_CONNECT_STRING="localhost:1521/XE"
+# DB_USER="secretsysuser"
+# DB_PASSWORD="secretpassword"
+
+## SQLite Example
+# DB_CLIENT="sqlite3"
+# DB_FILENAME="./data.db"
+
+## MySQL 5.7
+# DB_CLIENT="mysql"
+# DB_HOST="localhost"
+# DB_PORT=3306
+# DB_DATABASE="directus"
+# DB_USER="root"
+# DB_PASSWORD="secret"
+
+####################################################################################################
+### Rate Limiting
+
+# Whether or not to enable rate limiting on the API [false]
+RATE_LIMITER_ENABLED=false
+
+# Where to store the rate limiter counts [memory]
+# memory, redis, memcache
+RATE_LIMITER_STORE=memory
+# RATE_LIMITER_REDIS="redis://@127.0.0.1:5105"
+# RATE_LIMITER_MEMCACHE="localhost:5109"
+
+# The amount of allowed hits per duration [50]
+RATE_LIMITER_POINTS=25
+
+# The time window in seconds in which the hits are counted [1]
+RATE_LIMITER_DURATION=1
+
+####################################################################################################
+### Caching
+
+# Whether or not caching is enabled. [false]
+CACHE_ENABLED=false
+
+# How long the cache is persisted ["5m"]
+# CACHE_TTL="30m"
+
+# How to scope the cache data ["directus-cache"]
+# CACHE_NAMESPACE="directus-cache"
+
+# Automatically purge the cache on create, update, and delete actions. [false]
+# CACHE_AUTO_PURGE=true
+
+# memory | redis | memcache
+CACHE_STORE=memory
+
+# How long assets will be cached for in the browser. Sets the max-age value of the Cache-Control header ["30m"]
+ASSETS_CACHE_TTL="30m"
+
+# CACHE_REDIS="redis://@127.0.0.1:5105"
+# CACHE_MEMCACHE="localhost:5109"
+
+####################################################################################################
+### File Storage
+
+# A CSV of storage locations (eg: local,digitalocean,amazon) to use. You can use any names you'd like for these keys ["local"]
+STORAGE_LOCATIONS="local"
+STORAGE_LOCAL_DRIVER="local"
+STORAGE_LOCAL_ROOT="./uploads"
+
+## S3 Example (location name: DigitalOcean)
+# STORAGE_DIGITALOCEAN_DRIVER="s3"
+# STORAGE_DIGITALOCEAN_KEY="abcdef"
+# STORAGE_DIGITALOCEAN_SECRET="ghijkl"
+# STORAGE_DIGITALOCEAN_ENDPOINT="ams3.digitaloceanspaces.com"
+# STORAGE_DIGITALOCEAN_BUCKET="my-files"
+# STORAGE_DIGITALOCEAN_REGION="ams3"
+
+## Google Cloud Storage Example (location name: Google)
+# STORAGE_GOOGLE_DRIVER="gcs"
+# STORAGE_GOOGLE_KEY_FILENAME="abcdef"
+# STORAGE_GOOGLE_BUCKET="my-files"
+
+
+## A comma-separated list of metadata keys to collect during file upload. Use * for all
+# Extracting all metadata might cause memory issues when the file has an unusually large set of metadata
+# [ifd0.Make,ifd0.Model,exif.FNumber,exif.ExposureTime,exif.FocalLength,exif.ISO]
+# FILE_METADATA_ALLOW_LIST=
+
+####################################################################################################
+### Security
+
+{{ security }}
+
+# Unique identifier for the project
+# KEY="xxxxxxx-xxxxxx-xxxxxxxx-xxxxxxxxxx"
+
+# Secret string for the project
+# SECRET="abcdef"
+
+# The duration that the access token is valid ["15m"]
+ACCESS_TOKEN_TTL="15m"
+
+# The duration that the refresh token is valid, and also how long users stay logged-in to the App ["7d"]
+REFRESH_TOKEN_TTL="7d"
+
+# Whether or not to use a secure cookie for the refresh token in cookie mode [false]
+REFRESH_TOKEN_COOKIE_SECURE=false
+
+# Value for sameSite in the refresh token cookie when in cookie mode ["lax"]
+REFRESH_TOKEN_COOKIE_SAME_SITE="lax"
+
+# Name of refresh token cookie ["directus_refresh_token"]
+REFRESH_TOKEN_COOKIE_NAME="directus_refresh_token"
+
+# Which domain to use for the refresh cookie. Useful for development mode.
+# REFRESH_TOKEN_COOKIE_DOMAIN
+
+# Whether or not to enable the CORS headers [false]
+CORS_ENABLED=true
+
+# Value for the Access-Control-Allow-Origin header. Use true to match the Origin header, or provide a domain or a CSV of domains for specific access [false]
+CORS_ORIGIN=true
+
+# Value for the Access-Control-Allow-Methods header [GET,POST,PATCH,DELETE]
+CORS_METHODS=GET,POST,PATCH,DELETE
+
+# Value for the Access-Control-Allow-Headers header [Content-Type,Authorization]
+CORS_ALLOWED_HEADERS=Content-Type,Authorization
+
+# Value for the Access-Control-Expose-Headers header [Content-R
+CORS_EXPOSED_HEADERS=Content-Range
+
+# Whether or not to send the Access-Control-Allow-Credentials header [true]
+CORS_CREDENTIALS=true
+
+# Value for the Access-Control-Max-Age header [18000]
+CORS_MAX_AGE=18000
+
+####################################################################################################
+### Argon2
+
+# How much memory to use when generating hashes, in KiB [4096]
+# HASH_MEMORY_COST=81920
+
+# The length of the hash function output in bytes [32]
+# HASH_HASH_LENGTH=32
+
+# The amount of passes (iterations) used by the hash function. It increases hash strength at the cost of time required to compute [3]
+# HASH_TIME_COST=10
+
+# The amount of threads to compute the hash on. Each thread has a memory pool with HASH_MEMORY_COST size [1]
+# HASH_PARALLELISM=2
+
+# The variant of the hash function (0: argon2d, 1: argon2i, or 2: argon2id) [1]
+# HASH_TYPE=2
+
+# An extra and optional non-secret value. The value will be included B64 encoded in the parameters portion of the digest []
+# HASH_ASSOCIATED_DATA=foo
+
+####################################################################################################
+### Auth Providers
+
+# A comma-separated list of auth providers []
+AUTH_PROVIDERS=""
+# AUTH_PROVIDERS="github"
+
+# AUTH_GITHUB_DRIVER="oauth2"
+# AUTH_GITHUB_CLIENT_ID="73e...4b"
+# AUTH_GITHUB_CLIENT_SECRET="b9...98"
+# AUTH_GITHUB_AUTHORIZE_URL="https://github.com/login/oauth/authorize"
+# AUTH_GITHUB_ACCESS_URL="https://github.com/login/oauth/access_token"
+# AUTH_GITHUB_PROFILE_URL="https://api.github.com/user"
+# AUTH_GITHUB_ALLOW_PUBLIC_REGISTRATION=true
+# AUTH_GITHUB_DEFAULT_ROLE_ID="82424427-c9d4-4289-8bc5-ed1bf8422c90"
+# AUTH_GITHUB_ICON="github"
+# AUTH_GITHUB_EMAIL_KEY="email"
+# AUTH_GITHUB_IDENTIFIER_KEY="login"
+
+####################################################################################################
+### Extensions
+
+# Path to your local extensions folder ["./extensions"]
+EXTENSIONS_PATH="./extensions"
+
+# Automatically reload extensions when they have changed [false]
+EXTENSIONS_AUTO_RELOAD=false
+
+####################################################################################################
+### Email
+
+# Email address from which emails are sent ["no-reply@directus.io"]
+EMAIL_FROM="no-reply@directus.io"
+
+# What to use to send emails. One of
+# sendmail, smtp, mailgun, ses.
+EMAIL_TRANSPORT="sendmail"
+EMAIL_SENDMAIL_NEW_LINE="unix"
+EMAIL_SENDMAIL_PATH="/usr/sbin/sendmail"
+
+## Email (Sendmail Transport)
+
+# What new line style to use in sendmail ["unix"]
+EMAIL_SENDMAIL_NEW_LINE="unix"
+
+# Path to your sendmail executable ["/usr/sbin/sendmail"]
+EMAIL_SENDMAIL_PATH="/usr/sbin/sendmail"
+
+## Email (SMTP Transport)
+# EMAIL_SMTP_HOST="localhost"
+
+# Use SMTP pooling
+# EMAIL_SMTP_POOL=true
+# EMAIL_SMTP_PORT=465
+# EMAIL_SMTP_SECURE=false # Use TLS
+# EMAIL_SMTP_IGNORE_TLS=false
+# EMAIL_SMTP_USER="username"
+# EMAIL_SMTP_PASSWORD="password"
+
+## Email (Mailgun Transport)
+# EMAIL_MAILGUN_API_KEY="key-1234123412341234"
+# EMAIL_MAILGUN_DOMAIN="a domain name from https://app.mailgun.com/app/sending/domains"
+
+####################################################################################################
+## Default User
+ADMIN_EMAIL="admin@example.com"
+ADMIN_PASSWORD="password"
+
+####################################################################################################
+## NUXT SERVER
+NUXT_SERVER="http://localhost:3000"

package/templates/gitignore.liquid

@@ -0,0 +1,6 @@
+npm-debug.log
+node_modules
+.DS_Store
+server/uploads/*
+.vscode
+server/data.db

package/templates/package.json.liquid

@@ -0,0 +1,20 @@
+{
+	"name": "{{ appName }}",
+	"description": "",
+	"version": "0.0.1",
+	"keywords": [
+		"Directus",
+		"Nuxt",
+		"Nuxtus",
+		"Tailwind",
+		"Tailwindcss"
+	],
+	"scripts": {
+		"client": "cd client && npm run dev -- -o",
+		"server": "cd server && npx directus start",
+		"start": "concurrently \"npm run client\" \"npm run server\""
+	},
+	"devDependencies": {
+		"concurrently": "^7.2.2"
+	}
+}

package/server/.env

@@ -1,75 +0,0 @@
-####################################################################################################
-## General
-
-HOST="0.0.0.0"
-PORT=8055
-PUBLIC_URL="/"
-CORS_ENABLED=true
-CORS_ORIGIN=true
-
-####################################################################################################
-## Database
-
-DB_CLIENT="sqlite3"
-DB_FILENAME="./data.db"
-
-
-####################################################################################################
-## Rate Limiting
-
-RATE_LIMITER_ENABLED=false
-RATE_LIMITER_STORE=memory
-RATE_LIMITER_POINTS=25
-RATE_LIMITER_DURATION=1
-
-####################################################################################################
-## Cache
-
-CACHE_ENABLED=false
-
-####################################################################################################
-## File Storage
-
-STORAGE_LOCATIONS="local"
-STORAGE_LOCAL_DRIVER="local"
-STORAGE_LOCAL_ROOT="./uploads"
-
-####################################################################################################
-## Security
-
-KEY="3339424d-bc49-44dc-ac6c-5eed140f7b4d"
-SECRET="-3fcEkSym7BkfA5eLBOLb4EbMLpNF79E"
-
-
-ACCESS_TOKEN_TTL="15m"
-REFRESH_TOKEN_TTL="7d"
-REFRESH_TOKEN_COOKIE_SECURE=false
-REFRESH_TOKEN_COOKIE_SAME_SITE="lax"
-REFRESH_TOKEN_COOKIE_NAME="directus_refresh_token"
-
-####################################################################################################
-## Auth Providers
-
-AUTH_PROVIDERS=""
-
-####################################################################################################
-## Extensions
-
-EXTENSIONS_PATH="./extensions"
-
-####################################################################################################
-## Email
-
-EMAIL_FROM="no-reply@craigharman.com"
-EMAIL_TRANSPORT="sendmail"
-EMAIL_SENDMAIL_NEW_LINE="unix"
-EMAIL_SENDMAIL_PATH="/usr/sbin/sendmail"
-
-####################################################################################################
-## Default User
-ADMIN_EMAIL="admin@example.com"
-ADMIN_PASSWORD="password"
-
-####################################################################################################
-## NUXT SERVER
-NUXT_SERVER="http://localhost:3000"