create-directus-docker 1.4.2 → 1.4.4

package/README.md

@@ -35,6 +35,28 @@ GraphQL Playground: http://localhost:4000/graphql
 
 If you want to seed your database with data on first launch, place your .sql file(s) in the "init" directory at the root of this package, BEFORE you run all services. MySQL will run any files in this directory the first time it launches.
 
+### Snapshot the Data Model
+
+Directus can automatically generate a snapshot of your current data model in YAML format. This includes all collections, fields, and relations, and their configuration. This snapshot can be checked in version control and shared with your team. To generate the snapshot, run:
+
+`npm run snapshot`
+
+The 'directus' container **must be running** in order to take a snapshot.
+
+### Apply a Snapshot
+
+To overwrite the current Directus instance with the data model specified in that snapshot, you can apply a snapshot by running:
+
+`npm run snapshot-apply --snapshot=snapshot-file.yaml`
+
+Change the name of the file in the command to match an actual snapshot file in your 'snapshots' directory.
+
+By applying the snapshot, Directus will auto-detect the changes required to make the current instance up to date with the proposed data model in the snapshot file, and will run the required migrations to the database to make it match the snapshot. This is useful when migrating to/from another directus instance.
+
+**It is recommended that you test this first by doing a dry-run like this:**
+
+`npm run snapshot-test --snapshot=snapshot-file.yaml`
+
 ## Starting/stopping with Docker Compose
 
 To **stop** your running containers, simply run either `npm run stop` or  `docker compose down` from within the project directory. All containers will be stopped.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-directus-docker",
   "description": "An installer for Dockerized Directus + MySQL + Adminer + GraphiQL with a helper Node app",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "type": "module",
   "author": {
     "name": "Dave Kobrenski",

package/templates/default/README.md

@@ -41,6 +41,28 @@ As an alternative, you can install this package by following these steps. Once y
 
 If you want to seed your database with data on first launch, place your .sql file(s) in the "init" directory at the root of this package. MySQL will run any files in this directory the first time it launches.
 
+### Snapshot the Data Model
+
+Directus can automatically generate a snapshot of your current data model in YAML format. This includes all collections, fields, and relations, and their configuration. This snapshot can be checked in version control and shared with your team. To generate the snapshot, run:
+
+`npm run snapshot`
+
+The 'directus' container **must be running** in order to take a snapshot.
+
+### Apply a Snapshot
+
+To overwrite the current Directus instance with the data model specified in that snapshot, you can apply a snapshot by running:
+
+`npm run snapshot-apply --snapshot=snapshot-file.yaml`
+
+Change the name of the file in the command to match an actual snapshot file in your 'snapshots' directory.
+
+By applying the snapshot, Directus will auto-detect the changes required to make the current instance up to date with the proposed data model in the snapshot file, and will run the required migrations to the database to make it match the snapshot. This is useful when migrating to/from another directus instance.
+
+**It is recommended that you test this first by doing a dry-run like this:**
+
+`npm run snapshot-test --snapshot=snapshot-file.yaml`
+
 ### Starting/stopping with Docker Compose
 
 To **stop** your running containers, simply run `docker compose down` in your terminal from within the project directory. All containers will be stopped.

package/templates/default/docker-compose.yml

@@ -53,6 +53,7 @@ services:
       - ${DIRECTUS_PORT}:8055
     volumes:
       - ./directus/uploads:/directus/uploads
+      - ./snapshots:/directus/snapshots
     networks:
       - directus
     depends_on:

package/templates/default/lib/check-requirements.js

@@ -4,7 +4,7 @@ import { lookpath } from 'lookpath';
 export default async function checkRequirements() {
 	const nodeVersion = process.versions.node;
 	const major = +nodeVersion.split('.')[0];
-	const docker = await lookpath('bash');
+	const docker = await lookpath('docker');
 
 	if(!docker) {
 		console.error(`${chalk.red(`Docker needs to be installed and running`)}.`);
@@ -14,9 +14,9 @@ export default async function checkRequirements() {
 		process.exit(1);
 	}
 
-	if (major < 12) {
+	if (major < 14) {
 		console.error(`You are running ${chalk.red(`Node ${nodeVersion}`)}.`);
-		console.error(`Directus requires ${chalk.green(`Node 12`)} and up.`);
+		console.error(`Directus requires ${chalk.green(`Node 14`)} and up.`);
 		console.error('Please update your Node version and try again.');
 		process.exit(1);
 	}

package/templates/default/lib/index.js

@@ -62,6 +62,12 @@ try {
             });
         }
 
+        if (fs.existsSync(path.join(rootPath, 'snapshots')) === false) {
+            fs.mkdir(path.join(rootPath, 'snapshots'), () => {
+                //console.log(`'snapshots' directory created. If you want to seed your database on first lanch, place your .sql file(s) in this directory BEFORE running services.`);
+            });
+        }
+
         inquirer.prompt([
             {
                 name: 'ADMIN_EMAIL',

package/templates/default/lib/launch-services.js

@@ -44,7 +44,13 @@ export default function launchServices() {
     }
 
     launch.stderr.on('data', (data) => {
-        logUpdate(`${data}`);
+
+        if(data.includes('Cannot connect to the Docker daemon')) {
+            logUpdate(chalk.redBright(`${data}`));
+            process.exit(1);
+        } else {
+            logUpdate(`${data}`);
+        }
     });
 
     launch.on('close', code => {
@@ -111,27 +117,39 @@ export default function launchServices() {
                     //It may be that it's running, so let's be sure.
                     logUpdate('Directus taking a long time to respond...');
 
-                    const check = spawn('docker-compose', ['ps', '--format', 'json']);
+                    const check = spawn('docker-compose', ['ps', '-a', '--format', 'json']);
 
                     check.stdout.on('data', (data) => {
                         const q = 'map(select(.Name == "directus")) | .[0] | {Name: .Name, Service: .Service, State: .State}';
                         jq.run(q, data.toString(), { input: 'string' })
                             .then((data) => {
                                 const json = JSON.parse(data);
+                                console.log(data);
 
                                 if(json.State == 'running') {
                                     logUpdate(`${chalk.yellowBright("Directus appears to be running, but took a while to respond.")}`);
                                     console.log(`Just run ${chalk.greenBright("npm run launch")} to verify, and you should be good to go.`);
+
                                     logUpdate.done();
-                                    process.exit(1);
                                 } else {
+                                    logUpdate(`${chalk.redBright("Directus taking too long to respond. You may need to manually start it.")}`);
                                     logUpdate.done();
-                                    console.log(`${chalk.redBright("Directus taking too long to respond. You may need to manually start it.")}`);
                                     console.log(`Just run ${chalk.greenBright("npm run launch")} and you should be good to go.`);
-                                    process.exit(1);
                                 }
                             });
                     });
+
+                    check.on('close', (code) => {
+                        if (code !== 0) {
+                            console.log(`${chalk.redBright("Directus taking too long to respond. You may need to manually start it.")}`);
+                            console.log(`Just run ${chalk.greenBright("npm run launch")} and you should be good to go.`);
+                            console.log(`You can also check if it is running with ${chalk.greenBright("docker-compose ps")}`);
+                        } else {
+                            console.log(`${chalk.yellowBright("Directus appears to be running, but took a while to respond.")}`);
+                            console.log(`Just run ${chalk.greenBright("npm run launch")} to verify, and you should be good to go.`);
+                            console.log(`You can also check if it is running with ${chalk.greenBright("docker-compose ps")}`);
+                        }
+                    });
                 });
             });
         });

package/templates/default/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-mysql-docker",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A helper app to configure Directus on Docker with MySQL, Adminer, and GraphQL",
   "main": "./lib/index.js",
   "type": "module",
@@ -8,7 +8,9 @@
     "start": "node ./lib/index.js",
     "launch": "node ./lib/index.js",
     "stop": "docker-compose down",
-    "test": "echo \"No test specified\""
+    "snapshot": "docker-compose exec directus npx directus schema snapshot /directus/snapshots/\"$(date \"+%F\")\"-snapshot-\"$(date \"+%s\")\".yaml",
+    "snapshot-apply": "docker-compose exec directus npx directus schema apply /directus/snapshots/$npm_config_snapshot",
+    "snapshot-test": "docker-compose exec directus npx directus schema apply --dry-run /directus/snapshots/$npm_config_snapshot"
   },
   "bin": {
     "create-directus-docker": "./lib/index.js",