nuxi-docker 0.0.7 → 0.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,13 +1,22 @@
1
- # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
2
- # For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
3
1
 
4
- name: Node.js Package
2
+ name: Release
5
3
 
6
4
  on:
7
- release:
8
- types: [created]
5
+ push:
6
+ tags:
7
+ - "v*"
9
8
 
10
9
  jobs:
10
+ tagged-release:
11
+ permissions: write-all
12
+ runs-on: "ubuntu-latest"
13
+
14
+ steps:
15
+ - uses: "marvinpinto/action-automatic-releases@latest"
16
+ with:
17
+ repo_token: "${{ secrets.GITHUB_TOKEN }}"
18
+ prerelease: false
19
+
11
20
  build:
12
21
  runs-on: ubuntu-latest
13
22
  steps:
@@ -17,7 +26,7 @@ jobs:
17
26
  node-version: 16
18
27
 
19
28
  publish-npm:
20
- needs: build
29
+ needs: [tagged-release, build]
21
30
  runs-on: ubuntu-latest
22
31
  steps:
23
32
  - uses: actions/checkout@v3
package/README.md CHANGED
@@ -1,6 +1,28 @@
1
1
  # Nuxi-Docker
2
2
 
3
- Nuxi-Docker is a preconfigured Docker development environment tailored to streamline interaction with Nuxt.js projects using the Nuxi CLI.
3
+ Nuxi-Docker is a preconfigured Docker development environment for Nuxt.js projects, with a drop-in replacement for the Nuxi CLI.
4
+
5
+ Inspired by [Laravel Sail](https://laravel.com/docs/8.x/sail) and [Vessel](https://vessel.shippingdocker.com/).
6
+
7
+ ## Quick Start
8
+
9
+ Create a new Nuxt.js project:
10
+
11
+ ```bash
12
+ npx nuxi-docker init my-project
13
+ ```
14
+
15
+ Bring up the Docker environment:
16
+
17
+ ```bash
18
+ npx nuxi-docker up -d
19
+ ```
20
+
21
+ Use `nuxi-docker` as a drop-in replacement for `nuxi`:
22
+
23
+ ```bash
24
+ npx nuxi-docker dev
25
+ ```
4
26
 
5
27
  ## Installation
6
28
 
@@ -26,6 +48,14 @@ This command sets up the necessary configurations and Docker environment within
26
48
 
27
49
  ## Usage
28
50
 
51
+ ### Starting the Docker Environment
52
+
53
+ To start the Docker environment:
54
+
55
+ ```bash
56
+ npx nuxi-docker up -d
57
+ ```
58
+
29
59
  ### Commands Proxied to Nuxi
30
60
 
31
61
  The following commands are proxied directly to Nuxi in the app container:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nuxi-docker",
3
- "version": "0.0.7",
3
+ "version": "0.0.12",
4
4
  "description": "A preconfigured docker environment and cli tool for managing Nuxt.js projects",
5
5
  "main": "index.js",
6
6
  "bin": {