@nuxtus/nuxtus 1.0.0 → 1.0.4

package/README.md

@@ -12,47 +12,61 @@ It also includes [nuxtus/cli]("https://github.com/nuxtus/cli") which provides a
   - [Headless UI](https://headlessui.dev/)
   - [HeroIcons](https://heroicons.com/)
   - [Google Fonts](https://github.com/nuxt-community/google-fonts-module)
-  - [Nuxtus CLI]("https://github.com/nuxtus/cli")
+  - [Nuxtus CLI](https://github.com/nuxtus/cli)
 
 ## Quickstart (preferred)
 
 ```bash
 $ npx create-nuxtus app-name
-$ cd app-name
 ```
 
 > Replace `app-name` with the name of your website or application.
 
-Your project will contain 2 folders server (Directus) and client (Nuxt). Run them as normal from within each folder:
+Nuxtus will automatically start Directus and Nuxt in development mode if you are using SQLite. Otherwise follow the directions below to manually configure your database and get started.
+
+Your project will contain 2 folders server (Directus) and client (Nuxt).
+
+### Directus
+
+By default Nuxtus uses an SQLite database. If you wish to use an alternative database simply edit the `server/.env` file as suggested in the [Directus documentation](https://docs.directus.io/configuration/config-options/#database) then follow the steps below.
 
 ```bash
-~/server $ npx directus start
-~/client $ npm run dev
-```
+$ cd server
 
-## Production deployment
+# From within the root of the project
+$ npm run cli bootstrap
+```
 
-By default Directus is configured to accept CORS from any origin. Nuxtus suggests modifying this for your production deployment.
+### Nuxt
 
-## Manual setup
+No set up for Nuxt is required.
 
-Clone this repo onto your local machine, remove the remote git origin and add a new one.
+### Starting Nuxtus
 
-### Server (Directus) Setup
+From inside your project folder:
 
 ```bash
-$ cd server
-$ npm i
-$ npx directus start
+$ npm start
 ```
 
-### Client (Nuxt) Setup
+### Creating pages
 
-```bash
-$ cd client
-$ npm i
-$ npm run dev
-```
+Nuxtus includes Nuxtus CLI which will automatically generate listing and view pages of any Directus collections. To use it:
+
+1. Log in to Directus ([http://0.0.0.0:8055/admin/login](http://0.0.0.0:8055/admin/login)) and [create a collection](https://docs.directus.io/configuration/data-model/#creating-a-collection)
+2. From the client folder (`cd client`) run `nuxtus create` and follow the prompts
+
+Pages will be created for each collection you select in `clients/pages`. These are a starting point for you to customise.
+
+For more details on [Nuxtus CLI](https://github.com/nuxtus/cli) click [here](https://github.com/nuxtus/cli).
+
+## Production deployment
+
+By default Directus is configured to accept CORS from any origin. Nuxtus suggests modifying this for your production deployment.
+
+## Manual setup
+
+Clone this repo onto your local machine, remove the remote git origin and add a new one. Then follow the [manual install instructions](#directus).
 
 > For further instructions visit `[http://localhost:3000](http://localhost:3000)`
 

package/TODO

@@ -1,4 +1,14 @@
 
 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)
+  ✔ Add interactive/pretty CLI for create-app.js @done(22-06-16 20:23)
+  ☐ Query database use (via interactive shell) in create-app.js
+  ✔ 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/
+  ☐ Look into using a Directus hook to automatically generate the Nuxt pages!

package/changelog.md

@@ -1,5 +1,31 @@
 # Nuxtus
 
+## 1.0.4
+
+- Hard delete the data.db file
+- Update @nuxtus-cli to 1.0.2
+- Update Nuxt to 3.0.0-rc.4
+- Add client, server and start npm scripts
+
+## 1.0.3
+
+- Add Directus CLI to package.json so `npm run cli` works
+- Update getting started instructions to include database migrations
+- Do not upload the sqlite database, create a new one
+- Add default user/password to Directus .env
+- Add @nuxtus/cli to dev dependencies
+- Update `pages/docs.vue` with details on using @nuxtus/cli
+
+## 1.0.2
+
+- Separate create-nuxt command
+
+## 1.0.1
+
+- Correct create command in readme
+- Add details on using Nuxtus CLI
+- Update feedback when installing dependencies
+
 ## 1.0.0
 
 - Add `npx nuxtus-create` command

package/client/.env

@@ -3,5 +3,5 @@ DIRECTUS_URL=http://localhost:8055
 # Nuxtus values
 # For now using email and password as nuxt-directus does not support token auth
 # NUXT_PUBLIC_DIRECTUS_TOKEN=UNSECURE_ACCESS_TOKEN
-NUXT_PUBLIC_DIRECTUS_EMAIL=admin@test.com
+NUXT_PUBLIC_DIRECTUS_EMAIL=admin@example.com
 NUXT_PUBLIC_DIRECTUS_PASSWORD=password

package/client/package.json

@@ -9,11 +9,12 @@
   "devDependencies": {
     "@nuxtjs/google-fonts": "^1.3.0",
     "@nuxtjs/tailwindcss": "^5.0.4",
-    "nuxt": "3.0.0-rc.1"
+    "nuxt": "3.0.0-rc.4",
+    "@nuxtus/cli": "^1.0.2"
   },
   "dependencies": {
     "@headlessui/vue": "^1.6.1",
     "@heroicons/vue": "^1.0.6",
-    "nuxt-directus": "^2.0.1"
+    "nuxt-directus": "^2.1.0"
   }
 }

package/package.json

@@ -1,8 +1,7 @@
 {
 	"name": "@nuxtus/nuxtus",
 	"description": "Directus/Nuxt boilerplate with Tailwind CSS.",
-	"version": "1.0.0",
-	"main": "create-app.js",
+	"version": "1.0.4",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/nuxtus/nuxtus.git"
@@ -20,14 +19,16 @@
 		"url": "https://github.com/nuxtus/nuxtus/issues"
 	},
 	"homepage": "https://github.com/nuxtus/nuxtus#readme",
-	"bin": {
-		"create-nuxtus": "./create-app.js"
-	},
 	"publishConfig": {
 		"access": "public",
 		"registry": "https://registry.npmjs.org/"
 	},
-	"dependencies": {
-		"rimraf": "^3.0.2"
+	"scripts": {
+		"client": "cd client && npm run dev",
+		"server": "cd server && npx directus start",
+		"start": "concurrently \"npm run client\" \"npm run server\""
+	},
+	"devDependencies": {
+		"concurrently": "^7.2.2"
 	}
-}
+}

package/server/.env

@@ -64,3 +64,8 @@ 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"

package/server/package.json

@@ -4,6 +4,7 @@
   "description": "",
   "main": "index.js",
   "scripts": {
+    "cli": "directus",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],

package/create-app.js

@@ -1,64 +0,0 @@
-#!/usr/bin/env node
-
-const { execSync } = require("child_process")
-const path = require("path")
-const fs = require("fs")
-
-if (process.argv.length < 3) {
-	console.log("You have to provide a name for your app.")
-	console.log("For example :")
-	console.log("    npx create-nuxtus my-app")
-	process.exit(1)
-}
-
-const projectName = process.argv[2]
-const currentPath = process.cwd()
-const projectPath = path.join(currentPath, projectName)
-const git_repo = "https://github.com/nuxtus/nuxtus"
-
-try {
-	fs.mkdirSync(projectPath)
-} catch (err) {
-	if (err.code === "EEXIST") {
-		console.log(
-			`The folder ${projectName} already exist in the current directory, please try another name.`
-		)
-	} else {
-		console.log(error)
-	}
-	process.exit(1)
-}
-
-async function main() {
-	try {
-		console.log("Downloading files...")
-		execSync(`git clone --depth 1 ${git_repo} ${projectPath}`)
-
-		process.chdir(projectPath)
-
-		console.log("Installing dependencies...")
-		execSync("cd server && npm install")
-		execSync("cd client && npm install")
-
-		console.log("Removing unused files...")
-		execSync(
-			"npx rimraf ./.git ./create-app.js ./package.json ./package-lock.json ./TODO ./node_modules"
-		)
-		fs.rmdirSync(path.join(projectPath, "bin"), { recursive: true })
-		fs.appendFile(
-			".gitignore",
-			path.join("server", ".env") + "\n" + path.join("client", ".env"),
-			function (err) {
-				if (err) throw err
-				console.log("Saved!")
-			}
-		)
-
-		console.log(
-			"Nuxtus site is ready for use! Edit server/.env then start Directus."
-		)
-	} catch (error) {
-		console.log(error)
-	}
-}
-main()