@vendure/create 3.0.4 → 3.0.5

package/README.md

@@ -4,47 +4,17 @@ A CLI tool for rapidly scaffolding a new Vendure server application. Heavily ins
 
 ## Usage
 
-Vendure Create requires [Node.js](https://nodejs.org/en/) v8.9.0+ to be installed.
-
-To create a new project, you may choose one of the following methods:
-
-### npx
+Vendure Create requires [Node.js](https://nodejs.org/en/) v18+ to be installed.
 
 ```sh
 npx @vendure/create my-app
 ```
 
-*[npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher.*
-
-### npm
-
-```sh
-npm init @vendure my-app
-```
-
-*`npm init <initializer>` is available in npm 6+*
-
-### Yarn
-
-```sh
-yarn create @vendure my-app
-```
-
-*`yarn create` is available in Yarn 0.25+*
-
-
-It will create a directory called `my-app` inside the current folder.
-
 ## Options
 
-### `--use-npm`
-
-By default, Vendure Create will detect whether a compatible version of Yarn is installed, and if so will display a prompt to select the preferred package manager.
-You can override this and force it to use npm with the `--use-npm` flag.
-
 ### `--log-level`
 
-You can control how much output is generated during the installation and setup with this flag. Valid options are `silent`, `info` and `verbose`. The default is `silent`
+You can control how much output is generated during the installation and setup with this flag. Valid options are `silent`, `info` and `verbose`. The default is `info`
 
 Example:
 

package/assets/Dockerfile.hbs

@@ -3,7 +3,7 @@ FROM node:20
 WORKDIR /usr/src/app
 
 COPY package.json ./
-COPY {{#if useYarn}}yarn.lock{{else}}package-lock.json{{/if}} ./
-RUN {{#if useYarn}}yarn{{else}}npm install{{/if}} --production
+COPY package-lock.json ./
+RUN npm install --production
 COPY . .
-RUN {{#if useYarn}}yarn{{else}}npm run{{/if}} build
+RUN npm run build

package/assets/docker-compose.hbs

@@ -1,39 +1,115 @@
-version: "3"
+# INFORMATION
+# We are not exposing the default ports for the services in this file.
+# This is to avoid conflicts with existing services on your machine.
+# In case you don't have any services running on the default ports, you can expose them by changing the
+# ports section in the services block. Please don't forget to update the ports in the .env file as well.
+
 services:
-  server:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    ports:
-      - 3000:3000
-    command: [{{#if useYarn}}"yarn"{{else}}"npm", "run"{{/if}}, "start:server"]
-    volumes:
-      - /usr/src/app
-    environment:
-      DB_HOST: database
-      DB_PORT: 5432
-      DB_NAME: vendure
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-  worker:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    command: [{{#if useYarn}}"yarn"{{else}}"npm", "run"{{/if}}, "start:worker"]
-    volumes:
-      - /usr/src/app
-    environment:
-      DB_HOST: database
-      DB_PORT: 5432
-      DB_NAME: vendure
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-  database:
-    image: postgres
-    volumes:
-      - /var/lib/postgresql/data
-    ports:
-      - 5432:5432
-    environment:
-      POSTGRES_PASSWORD: password
-      POSTGRES_DB: vendure
+    postgres_db:
+        image: postgres:16-alpine
+        volumes:
+            - postgres_db_data:/var/lib/postgresql/data
+        ports:
+            - "6543:5432"
+        environment:
+            POSTGRES_DB: {{{ escapeSingle dbName }}}
+            POSTGRES_USER: {{{ escapeSingle dbUserName }}}
+            POSTGRES_PASSWORD: {{{ escapeSingle dbPassword }}}
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+
+    mysql_db:
+        image: mysql:8
+        volumes:
+            - mysql_db_data:/var/lib/mysql
+        environment:
+            MYSQL_ROOT_PASSWORD: 'ROOT'
+            MYSQL_DATABASE: {{{ escapeSingle dbName }}}
+            MYSQL_USER: {{{ escapeSingle dbUserName }}}
+            MYSQL_PASSWORD: {{{ escapeSingle dbPassword }}}
+        ports:
+            - "4306:3306"
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+
+    mariadb_db:
+        image: mariadb:10
+        volumes:
+            - mariadb_db_data:/var/lib/mysql
+        environment:
+            MARIADB_ROOT_PASSWORD: 'ROOT'
+            MARIADB_DATABASE: {{{ escapeSingle dbName }}}
+            MARIADB_USER: {{{ escapeSingle dbUserName }}}
+            MARIADB_PASSWORD: {{{ escapeSingle dbPassword }}}
+        ports:
+            - "3306:3306"
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+
+    # RECOMMENDED (especially for production)
+    # Want to use our BullMQ with Redis instead of our default database job queue?
+    # Checkout our BullMQ plugin: https://docs.vendure.io/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin/
+    redis:
+        image: redis:7-alpine
+        ports:
+            - "6479:6379"
+        volumes:
+            - redis_data:/data
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+
+    # RECOMMENDED
+    # Want to use Typesense instead of our default search engine?
+    # Checkout our advanced search plugin: https://vendure.io/hub/vendure-plus-advanced-search-plugin
+    # To run the typesense container run "docker compose up -d typesense"
+    typesense:
+        image: typesense/typesense:27
+        command: [ '--data-dir', '/data', '--api-key', 'SuperSecret' ]
+        ports:
+            - "8208:8108"
+        volumes:
+            - typesense_data:/data
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+
+    # Want to use Elasticsearch instead of our default database engine?
+    # Checkout our Elasticsearch plugin: https://docs.vendure.io/reference/core-plugins/elasticsearch-plugin/
+    # To run the elasticsearch container run "docker compose up -d elasticsearch"
+    elasticsearch:
+        image: docker.elastic.co/elasticsearch/elasticsearch:7.1.1
+        environment:
+            discovery.type: single-node
+            bootstrap.memory_lock: true
+            ES_JAVA_OPTS: -Xms512m -Xmx512m
+        volumes:
+            - elasticsearch_data:/usr/share/elasticsearch/data
+        ports:
+            - "9300:9200"
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+
+volumes:
+    postgres_db_data:
+        driver: local
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+    mysql_db_data:
+        driver: local
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+    mariadb_db_data:
+        driver: local
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+    typesense_data:
+        driver: local
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+    elasticsearch_data:
+        driver: local
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"
+    redis_data:
+        driver: local
+        labels:
+            - "io.vendure.create.name={{{ escapeSingle name }}}"

package/assets/readme.hbs

@@ -17,7 +17,7 @@ Useful links:
 ## Development
 
 ```
-{{#if useYarn}}yarn dev{{else}}npm run dev{{/if}}
+npm run dev
 ```
 
 will start the Vendure server and [worker](https://www.vendure.io/docs/developer-guide/vendure-worker/) processes from
@@ -26,7 +26,7 @@ the `src` directory.
 ## Build
 
 ```
-{{#if useYarn}}yarn build{{else}}npm run build{{/if}}
+npm run build
 ```
 
 will compile the TypeScript sources into the `/dist` directory.
@@ -41,7 +41,7 @@ hosting environment.
 You can run the built files directly with the `start` script:
 
 ```
-{{#if useYarn}}yarn start{{else}}npm run start{{/if}}
+npm run start
 ```
 
 You could also consider using a process manager like [pm2](https://pm2.keymetrics.io/) to run and manage
@@ -79,10 +79,24 @@ used in development.
 - `vendure` - we are referencing the tag we set up during the build.
 - `npm run start:server` - this last part is the actual command that should be run inside the container.
 
-### Docker compose
+### Docker Compose
 
-We've included a sample [docker-compose.yml](./docker-compose.yml) file which demonstrates how the server, worker, and
-database may be orchestrated with Docker Compose.
+We've included a [docker-compose.yml](./docker-compose.yml) file which includes configuration for commonly-used
+services such as PostgreSQL, MySQL, MariaDB, Elasticsearch and Redis.
+
+To use Docker Compose, you will need to have Docker installed on your machine. Here are installation
+instructions for [Mac](https://docs.docker.com/desktop/install/mac-install/), [Windows](https://docs.docker.com/desktop/install/windows-install/),
+and [Linux](https://docs.docker.com/desktop/install/linux/).
+
+You can start the services with:
+
+```shell
+docker-compose up <service>
+
+# examples:
+docker-compose up postgres_db
+docker-compose up redis
+```
 
 ## Plugins
 
@@ -92,7 +106,7 @@ These should be located in the `./src/plugins` directory.
 To create a new plugin run:
 
 ```
-{{#if useYarn}}yarn{{else}}npx{{/if}} vendure add
+npx vendure add
 ```
 
 and select `[Plugin] Create a new Vendure plugin`.
@@ -105,7 +119,7 @@ will be required whenever you make changes to the `customFields` config or defin
 To generate a new migration, run:
 
 ```
-{{#if useYarn}}yarn{{else}}npx{{/if}} vendure migrate
+npx vendure migrate
 ```
 
 The generated migration file will be found in the `./src/migrations/` directory, and should be committed to source control.