@nuxtus/nuxtus 2.1.0 → 2.2.0

package/.github/workflows/release.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: "16.x"
+          node-version: "20.x"
       - run: npm ci
       # - run: npm run build --if-present
       # - run: npm test
@@ -21,4 +21,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - run: echo ${{ github.event.release.tag_name }} > .version 
+      - run: echo ${{ github.event.release.tag_name }} > .version

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 Changelog
 
+# [2.2.0](https://github.com/nuxtus/nuxtus/compare/v2.1.0...v2.2.0) (2024-02-21)
+
+
+### Bug Fixes
+
+* **deps:** update dependency directus to v10 ([c5f56db](https://github.com/nuxtus/nuxtus/commit/c5f56db520b6b89b2ab3dce73018f867736b83c4))
+* **deps:** update dependency nuxt-directus to v5 ([a377f27](https://github.com/nuxtus/nuxtus/commit/a377f27853b0c9c660712c0af1cc7eedd8fe7065))
+
+
+### Features
+
+* :sparkles: authenticate via token or use public role ([69e1ee4](https://github.com/nuxtus/nuxtus/commit/69e1ee44bb48581bdaf404a6a4ad8233e4b79008))
+
 # [2.1.0](https://github.com/nuxtus/nuxtus/compare/v2.0.1...v2.1.0) (2022-11-18)
 
 

package/README.md

@@ -1,8 +1,7 @@
 # Nuxtus
+<img src="https://www.nuxtus.com/imgs/logo.svg" alt="Nuxtus Logo" width="300px"/>
 
-![Nuxtus Logo](https://www.nuxtus.com/imgs/logo.svg)
-
-A website w/ CMS boilerplate and set of utilities for using [Directus](https://directus.io) for backend CMS and [Nuxt](https://nuxtjs.org) (w/ Tailwind CSS) for frontend. Can also **automagically** create *typed* pages when you create Directus collections.
+A boilerplate and set of utilities for using [Directus](https://directus.io) for backend CMS and [Nuxt](https://nuxtjs.org) (w/ [Tailwind CSS](https://tailwindcss.com)) for frontend. It's core feature is to **automagically** create *typed* pages the instant you create a Directus collection.
 
 > Can be used as a boilerplate or individually as a suite of utilities.
 
@@ -12,10 +11,22 @@ A website w/ CMS boilerplate and set of utilities for using [Directus](https://d
 npx create-nuxtus app-name
 ```
 
-For more details visit [nuxtus.com](https://nuxtus.com) or [read the documentation](https://docs.nuxtus.com)
+For more details visit [nuxtus.com](https://www.nuxtus.com) or [read the documentation](https://docs.nuxtus.com)
 
 https://user-images.githubusercontent.com/324026/175020548-57ee94b3-dee4-4b12-a8c8-6c0f1a94fab4.mov
 
 The purpose of this template is to be a quick-start for developing a website with Nuxt.js using Directus as the backend. The end result can be a static website or dynamically pull data from Directus depending on your preference.
 
 It also includes [nuxtus/cli]("https://github.com/nuxtus/cli") which provides a command line interface for quickly creating multiple index/detail pages from any Directus collections.
+
+### Dependency graph
+
+The below shows the Nuxtus projects in order based on packages that depend on each other with generator having no Nuxtus dependencies and create-nuxtus requiring all packages. This assists in development and deployment of new versions.
+
+generator :: creates nuxt pages from Directus collections
+nuxt-module :: a Nuxt module that includes generator for creating nuxt pages in a nuxt project during development
+nuxt-cli :: a CLI tool to manually generate Nuxt pages rather than using autogeneration, used within a Nuxt project
+localtunnel :: a Nuxt module that allows external access to a local Nuxt development project using Local Tunnel
+hook :: a Directus webhook extension that handles the automatic creation of Nuxt pages and types when a new collection is created in Directus
+nuxtus :: the boilerplate project used by create-nuxtus to generate the Directus server and Nuxtus client
+create-nuxtus :: npx package to quickly and easily create a new Nuxtus project

package/TODO

@@ -1,13 +1,28 @@
 
 Todo:
+  ✔ URGENT: SHOULD MOVE DIRECTUS CREDENTIALS OUT OF PUBLIC runtime config! Should be private or recommend using a user with only read permissions! @done(24-02-18 21:35)
+  ✔ Move the Directus email/password and token to private server variables and use a server middleware (https://nuxt.com/docs/guide/directory-structure/server#server-middleware) to login and provide AUTH_TOKEN back to client. This workflow only needed if not rendering a static site. @done(24-02-19 16:49)
+  ✔ Make nuxtus/nuxtus readme more of a landing page for the entire nuxt project @done(22-11-19 15:20)
+  ✔ Move @nuxtus/generator to Rollup v3 @done(24-02-14 19:48)
+  ✔ Had an issue when a Directus collection name had a space in it (eg. "Builder Pages") in generator @done(24-02-19 21:03)
+  ☐ Set up automatic renovate for packages with tests
+  ✔ Update nuxt and change to ^3 in nuxtus/client @done(24-02-19 16:51)
+  ✔ Automatically add directus credentials to /client/nuxt.config.ts (They are not inside runtime -> public and are expected there at the moment. Shouldn't be using admin creds there!!!!) @done(24-02-18 21:34)
+  ✔ Node needs to be 20 everywhere now! (Otherwise Directus won't start) @done(24-02-19 15:14)
+  ✔ Write some docs on "permissions" - options being a publicly accessible read of collections OR a token. Put this in a quickstart and in more detail @done(24-02-19 08:12)
+  ✔ Fix breaking tests @done(24-02-20 21:08)
+
+Future features:
+  ☐ Add a nuxtus.config.json file that allows include/exclude of collections to create, perhaps also if they are components or pages?
   ☐ GraphQL?
   ☐ Websockets (https://github.com/br41nslug/directus-websocket-subscribe)
   ☐ Nuxtus website should actually pull data from Directus!
   ☐ Detect when Directus is not running and show error message
-  ☐ Use nuxt.config in generator login.ts instead of env
-  ☐ Move the Directus email/password and token to private server variables and use a server middleware (https://nuxt.com/docs/guide/directory-structure/server#server-middleware) to login and provide AUTH_TOKEN back to client. This workflow only needed if not rendering a static site.
-  ☐ Make nuxtus/nuxtus readme more of a landing page for the entire nuxt project
-  ☐ Move @nuxtus/generator to Rollup v3
+  ☐ If Collections are hidden, don't create Nuxtus pages?
+  ☐ Remove google fonts as a dependency?
+  ☐ Move generator from rollup to vite
+  ☐ Automatically request all fields of a collection in the query
+  ☐ Use nuxt.config in generator login.ts instead of env?
 
 Archive:
   ✔ Make opening browser window on start optional using npm run start (not possible) @done(22-09-14 16:44) @project(Todo)